Skip to main content
PATCH
/
v2
/
orgs
/
{orgSlug}
/
api-keys
/
{keyId}
Update Org API Key
curl --request PATCH \
  --url https://api.studio.prisme.ai/v2/orgs/{orgSlug}/api-keys/{keyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "scopes": [
    "<string>"
  ],
  "ownerType": "<string>",
  "ownerId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "disabled": true
}
'
{
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "scopes": [
    "<string>"
  ],
  "ownerType": "<string>",
  "ownerId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "disabled": true,
  "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
orgSlug
string
required
​
keyId
string
required

Body

application/json
​
name
string
​
permissions
string[]

Array of permission strings. Convention: {product}:{resource}:{action} Wildcards: Use * at end only (e.g., orgs:* matches orgs:members:manage) Platform permissions: - orgs:* (full org access) - orgs:members:manage, orgs:roles:manage, orgs:manage - orgs:branding:manage, orgs:navigation:manage - orgs:subscriptions:view, orgs:subscriptions:manage - orgs:apikeys:manage, orgs:invites:manage, orgs:join-rules:manage - secure-chat:, store:, knowledge:, builder: - agent-builder:, analytics:view, platform-admin: Custom app permissions: {app-slug}:{resource}:{action} Example: my-crm:contacts:read, my-crm:deals:manage Super admin: ["*"] (matches everything)

​
scopes
string[]

Optional resource patterns restricting where permissions apply. Format: resourceType:resourceId

​
ownerType
string

Optional owner type for this API key (e.g. agent, user, app).

​
ownerId
string

Optional owner ID for this API key.

​
expiresAt
string<date-time>
​
disabled
boolean

Response

Success

​
id
string

Internal role ID

​
slug
string

Unique slug identifying the API key within the org

​
name
string
​
permissions
string[]

Array of permission strings. Convention: {product}:{resource}:{action} Wildcards: Use * at end only (e.g., orgs:* matches orgs:members:manage) Platform permissions: - orgs:* (full org access) - orgs:members:manage, orgs:roles:manage, orgs:manage - orgs:branding:manage, orgs:navigation:manage - orgs:subscriptions:view, orgs:subscriptions:manage - orgs:apikeys:manage, orgs:invites:manage, orgs:join-rules:manage - secure-chat:, store:, knowledge:, builder: - agent-builder:, analytics:view, platform-admin: Custom app permissions: {app-slug}:{resource}:{action} Example: my-crm:contacts:read, my-crm:deals:manage Super admin: ["*"] (matches everything)

​
scopes
string[]

Optional string array of resource patterns restricting where permissions apply. Format: resourceType:resourceId. Examples: agents:agent-abc-123, models:gpt-4o, orgs:acme, agents:, models:, *

​
ownerType
string

Optional owner type identifier for this API key (e.g. agent, user, app). Indexed alongside ownerId for fast lookups.

​
ownerId
string

Optional owner ID for this API key. Indexed alongside ownerType for fast lookups.

​
expiresAt
string<date-time>
​
disabled
boolean
​
createdAt
string
​
updatedAt
string