Platform API
- GETList Organizations
- POSTCreate Organization
- GETGet Organization
- DELDelete Organization
- PATCHUpdate Organization
- GETList Org Members
- POSTAdd Org Members
- DELRemove Org Members
- POSTExport Org Members as CSV
- GETGet Org Member
- DELRemove Org Member
- PATCHUpdate Org Member
- GETList Org Invites
- POSTCreate Org Invite
- GETGet Org Invite
- DELRevoke Org Invite
- GETJoin Organization
- GETList Org Roles
- POSTCreate Org Role
- GETGet Org Role
- DELDelete Org Role
- PATCHUpdate Org Role
- GETList Org API Keys
- POSTCreate Org API Key
- GETGet Org API Key
- DELDelete Org API Key
- PATCHUpdate Org API Key
- POSTRotate Org API Key
- POSTValidate Org API Key
- GETList Org Service Accounts
- POSTCreate Org Service Account
- GETGet Org Service Account
- DELDelete Org Service Account
- PATCHUpdate Org Service Account
- POSTRotate Org Service Account Secret
- POSTIssue Org Service Account Token
- GETList Org Groups
- POSTCreate Org Group
- GETGet Org Group
- DELDelete Org Group
- PATCHUpdate Org Group
- GETList Org Group Members
- POSTAdd Org Group Members
- DELRemove Org Group Members
Agent Creator API
LLM Gateway API
Governance API
curl --request PATCH \
--url https://api.studio.prisme.ai/v2/orgs/{orgSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"slug": "<string>"
}
'{
"name": "<string>",
"slug": "<string>",
"id": "<string>",
"description": "<string>",
"photo": "<string>",
"status": "active",
"domains": [
"<string>"
],
"branding": {
"version": "<string>",
"platformName": "<string>",
"description": "<string>",
"logo": {
"light": "<string>",
"dark": "<string>"
},
"favicon": "<string>",
"colors": {
"primary": "<string>",
"secondary": "<string>",
"accent": "<string>"
},
"fonts": {
"heading": "<string>",
"body": "<string>"
},
"customCssUrl": "<string>",
"customCssInline": "<string>"
},
"navigation": {
"version": 123,
"homePage": "<string>",
"menu": [
{
"id": "<string>",
"type": "category",
"label": "<string>",
"icon": "<string>",
"color": "<string>",
"href": "<string>",
"target": "_self",
"expanded": true,
"badge": "<string>",
"permissions": [
"<string>"
],
"features": [
{
"type": "agent",
"slug": "<string>",
"label": "<string>",
"agentId": "<string>",
"templateId": "<string>",
"permissions": [
"<string>"
]
}
],
"visibility": {
"tiers": [
"<string>"
],
"features": [
"<string>"
]
},
"items": "<array>"
}
],
"footer": [
{
"id": "<string>",
"type": "category",
"label": "<string>",
"icon": "<string>",
"color": "<string>",
"href": "<string>",
"target": "_self",
"expanded": true,
"badge": "<string>",
"permissions": [
"<string>"
],
"features": [
{
"type": "agent",
"slug": "<string>",
"label": "<string>",
"agentId": "<string>",
"templateId": "<string>",
"permissions": [
"<string>"
]
}
],
"visibility": {
"tiers": [
"<string>"
],
"features": [
"<string>"
]
},
"items": "<array>"
}
],
"quickActions": [
{
"id": "<string>",
"type": "category",
"label": "<string>",
"icon": "<string>",
"color": "<string>",
"href": "<string>",
"target": "_self",
"expanded": true,
"badge": "<string>",
"permissions": [
"<string>"
],
"features": [
{
"type": "agent",
"slug": "<string>",
"label": "<string>",
"agentId": "<string>",
"templateId": "<string>",
"permissions": [
"<string>"
]
}
],
"visibility": {
"tiers": [
"<string>"
],
"features": [
"<string>"
]
},
"items": "<array>"
}
]
},
"joinRules": [
{
"rules": [
{
"field": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"role": "<string>",
"groups": [
"<string>"
]
}
],
"defaultRole": "<string>",
"auth": {
"anonymous": {
"enabled": true,
"role": "<string>",
"allowedDomains": [
{
"domain": "<string>",
"role": "<string>"
}
]
}
},
"settings": {},
"subscriptionSlug": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}Update Organization
Update an organization
curl --request PATCH \
--url https://api.studio.prisme.ai/v2/orgs/{orgSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"slug": "<string>"
}
'{
"name": "<string>",
"slug": "<string>",
"id": "<string>",
"description": "<string>",
"photo": "<string>",
"status": "active",
"domains": [
"<string>"
],
"branding": {
"version": "<string>",
"platformName": "<string>",
"description": "<string>",
"logo": {
"light": "<string>",
"dark": "<string>"
},
"favicon": "<string>",
"colors": {
"primary": "<string>",
"secondary": "<string>",
"accent": "<string>"
},
"fonts": {
"heading": "<string>",
"body": "<string>"
},
"customCssUrl": "<string>",
"customCssInline": "<string>"
},
"navigation": {
"version": 123,
"homePage": "<string>",
"menu": [
{
"id": "<string>",
"type": "category",
"label": "<string>",
"icon": "<string>",
"color": "<string>",
"href": "<string>",
"target": "_self",
"expanded": true,
"badge": "<string>",
"permissions": [
"<string>"
],
"features": [
{
"type": "agent",
"slug": "<string>",
"label": "<string>",
"agentId": "<string>",
"templateId": "<string>",
"permissions": [
"<string>"
]
}
],
"visibility": {
"tiers": [
"<string>"
],
"features": [
"<string>"
]
},
"items": "<array>"
}
],
"footer": [
{
"id": "<string>",
"type": "category",
"label": "<string>",
"icon": "<string>",
"color": "<string>",
"href": "<string>",
"target": "_self",
"expanded": true,
"badge": "<string>",
"permissions": [
"<string>"
],
"features": [
{
"type": "agent",
"slug": "<string>",
"label": "<string>",
"agentId": "<string>",
"templateId": "<string>",
"permissions": [
"<string>"
]
}
],
"visibility": {
"tiers": [
"<string>"
],
"features": [
"<string>"
]
},
"items": "<array>"
}
],
"quickActions": [
{
"id": "<string>",
"type": "category",
"label": "<string>",
"icon": "<string>",
"color": "<string>",
"href": "<string>",
"target": "_self",
"expanded": true,
"badge": "<string>",
"permissions": [
"<string>"
],
"features": [
{
"type": "agent",
"slug": "<string>",
"label": "<string>",
"agentId": "<string>",
"templateId": "<string>",
"permissions": [
"<string>"
]
}
],
"visibility": {
"tiers": [
"<string>"
],
"features": [
"<string>"
]
},
"items": "<array>"
}
]
},
"joinRules": [
{
"rules": [
{
"field": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"role": "<string>",
"groups": [
"<string>"
]
}
],
"defaultRole": "<string>",
"auth": {
"anonymous": {
"enabled": true,
"role": "<string>",
"allowedDomains": [
{
"domain": "<string>",
"role": "<string>"
}
]
}
},
"settings": {},
"subscriptionSlug": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
PATCH body for /v2/orgs/{orgSlug}. Same shape as Organization but no required fields — slug is taken from the URL path, name defaults to the current value. Lets field-scoped roles (orgs:branding:manage, orgs:auth:manage, etc.) PATCH without having to include name/slug.
active, suspended Hide child attributes
Hide child attributes
Organization navigation configuration
Hide child attributes
Hide child attributes
Schema version number
Route to use as home page (e.g., "/apps/agent-factory"). Must be a valid relative path starting with /. If not set, defaults to the platform default (SecureChat).
^\/[a-zA-Z0-9\-_\/]*$Main menu items
Hide child attributes
Hide child attributes
Unique identifier for this menu item
category, item, divider Display label (not required for dividers)
Icon name (from lucide-react)
Icon color (CSS color value)
Link destination (for type=item)
Link target
_self, _blank Whether category is expanded by default
Badge text to show (e.g., "New", "Beta")
Permissions required to see this item
Features attached to this item
Hide child attributes
Hide child attributes
agent, template Unique identifier for this feature within the menu item
Display label for the feature
Agent ID (required when type=agent)
Template ID (required when type=template)
Permissions required to see this feature
Child items (for type=category)
Footer menu items
Hide child attributes
Hide child attributes
Unique identifier for this menu item
category, item, divider Display label (not required for dividers)
Icon name (from lucide-react)
Icon color (CSS color value)
Link destination (for type=item)
Link target
_self, _blank Whether category is expanded by default
Badge text to show (e.g., "New", "Beta")
Permissions required to see this item
Features attached to this item
Hide child attributes
Hide child attributes
agent, template Unique identifier for this feature within the menu item
Display label for the feature
Agent ID (required when type=agent)
Template ID (required when type=template)
Permissions required to see this feature
Child items (for type=category)
Quick action buttons
Hide child attributes
Hide child attributes
Unique identifier for this menu item
category, item, divider Display label (not required for dividers)
Icon name (from lucide-react)
Icon color (CSS color value)
Link destination (for type=item)
Link target
_self, _blank Whether category is expanded by default
Badge text to show (e.g., "New", "Beta")
Permissions required to see this item
Features attached to this item
Hide child attributes
Hide child attributes
agent, template Unique identifier for this feature within the menu item
Display label for the feature
Agent ID (required when type=agent)
Template ID (required when type=template)
Permissions required to see this feature
Child items (for type=category)
Auto-join rules. Each item is an OR case with AND-chained conditions in rules[]. Example: [{ rules: [{ field: "email", operator: "endsWith", value: "@acme.com" }], role: "member", groups: ["engineering"] }]
Hide child attributes
Hide child attributes
Conditions that must ALL match (AND logic)
Hide child attributes
Hide child attributes
User attribute to match, supports dot notation for nested fields (e.g. "email", "authData.google.hd")
Match operator. "matches" supports wildcard patterns (e.g. "@acme.com", "" to match any value)
equals, startsWith, endsWith, matches Value to match against (case-insensitive)
Role slug to assign (defaults to org's defaultRole)
Group slugs to add the user to
Organization-scoped authentication settings
Hide child attributes
Hide child attributes
Settings for anonymous sessions scoped to this organization. When enabled, callers of POST /v2/login/anonymous can pass this org's slug to receive a token bound to the configured role.
Hide child attributes
Hide child attributes
Whether anonymous sessions are allowed for this org
Org role slug (e.g. "org:member" or a custom role) applied to anonymous sessions targeting this org. Required when enabled is true. Owner/Admin and roles with wildcard permissions are forbidden.
Origin hostnames allowed to create anonymous sessions for this org. When non-empty, the gateway:
- Auto-resolves orgSlug from the request's Origin/Referer when the body field is omitted (single-org match per hostname).
- Rejects /login/anonymous calls whose Origin host does not match
any entry — even when the body explicitly carries this orgSlug.
Each entry is a hostname (e.g. "chat.acme.com") or a subdomain wildcard (e.g. "*.acme.com") with an optional per-domain role override. When
roleis set, it takes precedence overauth.anonymous.rolefor sessions opened from that domain. When empty/undefined, any Origin is accepted but auto-detection is disabled (the body must carry orgSlug).
Hide child attributes
Hide child attributes
Hostname (e.g. "chat.acme.com") or subdomain wildcard ("*.acme.com")
Optional org role slug applied to anonymous sessions opened from this specific domain. Falls back to the top-level auth.anonymous.role when omitted. Same Owner/Admin/wildcard restrictions apply.
Response
Success
active, suspended Hide child attributes
Hide child attributes
Organization navigation configuration
Hide child attributes
Hide child attributes
Schema version number
Route to use as home page (e.g., "/apps/agent-factory"). Must be a valid relative path starting with /. If not set, defaults to the platform default (SecureChat).
^\/[a-zA-Z0-9\-_\/]*$Main menu items
Hide child attributes
Hide child attributes
Unique identifier for this menu item
category, item, divider Display label (not required for dividers)
Icon name (from lucide-react)
Icon color (CSS color value)
Link destination (for type=item)
Link target
_self, _blank Whether category is expanded by default
Badge text to show (e.g., "New", "Beta")
Permissions required to see this item
Features attached to this item
Hide child attributes
Hide child attributes
agent, template Unique identifier for this feature within the menu item
Display label for the feature
Agent ID (required when type=agent)
Template ID (required when type=template)
Permissions required to see this feature
Child items (for type=category)
Footer menu items
Hide child attributes
Hide child attributes
Unique identifier for this menu item
category, item, divider Display label (not required for dividers)
Icon name (from lucide-react)
Icon color (CSS color value)
Link destination (for type=item)
Link target
_self, _blank Whether category is expanded by default
Badge text to show (e.g., "New", "Beta")
Permissions required to see this item
Features attached to this item
Hide child attributes
Hide child attributes
agent, template Unique identifier for this feature within the menu item
Display label for the feature
Agent ID (required when type=agent)
Template ID (required when type=template)
Permissions required to see this feature
Child items (for type=category)
Quick action buttons
Hide child attributes
Hide child attributes
Unique identifier for this menu item
category, item, divider Display label (not required for dividers)
Icon name (from lucide-react)
Icon color (CSS color value)
Link destination (for type=item)
Link target
_self, _blank Whether category is expanded by default
Badge text to show (e.g., "New", "Beta")
Permissions required to see this item
Features attached to this item
Hide child attributes
Hide child attributes
agent, template Unique identifier for this feature within the menu item
Display label for the feature
Agent ID (required when type=agent)
Template ID (required when type=template)
Permissions required to see this feature
Child items (for type=category)
Auto-join rules. Each item is an OR case with AND-chained conditions in rules[]. Example: [{ rules: [{ field: "email", operator: "endsWith", value: "@acme.com" }], role: "member", groups: ["engineering"] }]
Hide child attributes
Hide child attributes
Conditions that must ALL match (AND logic)
Hide child attributes
Hide child attributes
User attribute to match, supports dot notation for nested fields (e.g. "email", "authData.google.hd")
Match operator. "matches" supports wildcard patterns (e.g. "@acme.com", "" to match any value)
equals, startsWith, endsWith, matches Value to match against (case-insensitive)
Role slug to assign (defaults to org's defaultRole)
Group slugs to add the user to
Organization-scoped authentication settings
Hide child attributes
Hide child attributes
Settings for anonymous sessions scoped to this organization. When enabled, callers of POST /v2/login/anonymous can pass this org's slug to receive a token bound to the configured role.
Hide child attributes
Hide child attributes
Whether anonymous sessions are allowed for this org
Org role slug (e.g. "org:member" or a custom role) applied to anonymous sessions targeting this org. Required when enabled is true. Owner/Admin and roles with wildcard permissions are forbidden.
Origin hostnames allowed to create anonymous sessions for this org. When non-empty, the gateway:
- Auto-resolves orgSlug from the request's Origin/Referer when the body field is omitted (single-org match per hostname).
- Rejects /login/anonymous calls whose Origin host does not match
any entry — even when the body explicitly carries this orgSlug.
Each entry is a hostname (e.g. "chat.acme.com") or a subdomain wildcard (e.g. "*.acme.com") with an optional per-domain role override. When
roleis set, it takes precedence overauth.anonymous.rolefor sessions opened from that domain. When empty/undefined, any Origin is accepted but auto-detection is disabled (the body must carry orgSlug).
Hide child attributes
Hide child attributes
Hostname (e.g. "chat.acme.com") or subdomain wildcard ("*.acme.com")
Optional org role slug applied to anonymous sessions opened from this specific domain. Falls back to the top-level auth.anonymous.role when omitted. Same Owner/Admin/wildcard restrictions apply.
Was this page helpful?