List API keys

Lists the API keys scoped to this collection. Raw keys are never returned.

GET /v1/collections/{collection_id}/api-keys

List API keys

cURL

curl --request GET \
  --url https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/collections/{collection_id}/api-keys \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "list",
  "items": [
    {
      "id": "<string>",
      "object": "collection.api_key",
      "collection_id": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "scope": "ai-collection-v3:collections:3f2a9c1e-...",
      "permissions": [
        "<string>"
      ],
      "expires_at": 123
    }
  ],
  "total": 123
}

Authorizations

BearerAuthOrgApiKeyAuth

Authorization · string · header · required

User session JWT. Send as Authorization: Bearer <token>.

Path Parameters

collection_id · string<uuid> · required

Collection identifier returned at creation.

Response

200

application/json

API keys.

object · string

Example:

"list"

items · object[]

Hide child attributes

items. id · string

items. object · string

Example:

"collection.api_key"

items. collection_id · string

items. slug · string

items. name · string

items. scope · string

Example:

"ai-collection-v3:collections:3f2a9c1e-..."

items. permissions · string[]

items. expires_at · integer

Unix seconds.

total · integer