Skip to main content

API Keys

Manage API keys for your organization.

List API Keys​

GET /v1/api-keys

Returns all API keys (without exposing the full key).

curl https://scribesight.com/api/v1/api-keys \
  -H "Authorization: Bearer sk_live_xxx"

Response​

{
  "data": [
    {
      "id": "key_xxxxxxxxxxxx",
      "name": "Production API",
      "key_prefix": "sk_live_xxxx",
      "key_type": "secret",
      "scopes": ["read", "write"],
      "project_ids": null,
      "last_used_at": "2026-01-06T14:30:00Z",
      "created_at": "2025-12-01T10:00:00Z"
    }
  ]
}

Create API Key​

POST /v1/api-keys

Creates a new API key.

Request Body​

FieldTypeRequiredDescription
namestringYesKey name
scopesarrayNo["read"] or ["read", "write"]
project_idsarrayNoRestrict to specific projects
curl -X POST https://scribesight.com/api/v1/api-keys \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CI/CD Pipeline",
    "scopes": ["read", "write"]
  }'

Revoke API Key​

DELETE /v1/api-keys/{keyId}

Revokes an API key immediately.

warning

You cannot revoke the API key currently being used for the request.