Cuddler Authentication

generated: '2026-11-04'
method: searched
source: https://platform.cuddler.ai/docs/authentication
summary:
  types:
  - http
schemes:
- name: PlatformApiKey
  type: http
  scheme: bearer
  bearerFormat: cud_sk_live_…
  description: An organization API key issued by Cuddler (cud_sk_live_… spends the organization's prepaid USD balance;
    cud_sk_test_… can only read the catalog, estimate, and read the balance and usage).
  sources:
  - openapi/cuddler-ai-openapi.yml
  - https://platform.cuddler.ai/docs/authentication
  key_prefixes:
    live: cud_sk_live_
    test: cud_sk_test_
  header: 'Authorization: Bearer $CUDDLER_API_KEY'
docs: https://platform.cuddler.ai/docs/authentication
derived_from: openapi/cuddler-ai-openapi.yml
key_management:
  owner: organization (not a person)
  live_prefix: cud_sk_live_
  test_prefix: cud_sk_test_
  shown_once: true
  storage: hash only; a lost key must be revoked and recreated
  revocation: console (owners, admins, developers); a revoked key stops working immediately
  rotation: create a new key, deploy it, then revoke the old one
errors:
- status: 401
  code: unauthorized
- status: 403
  code: forbidden
- status: 403
  code: organization_suspended
- status: 403
  code: model_not_enabled
notes:
- Keys belong to the organization, not to a person; every job records api_key_id.
- Test keys can call GET /v1/models, GET /v1/models/{id}, POST /v1/videos/estimate, POST /v1/images/estimate, GET
  /v1/balance and GET /v1/usage only; any other call answers 403 forbidden.
- The full key is shown once at creation; only a hash is stored. Owners, admins and developers create and revoke
  keys in the console; a revoked key stops working immediately.
- No OAuth flows are documented, so no scopes artifact applies.