api-keys

Create a scoped API key (session credential only)

post/v1/api-keys

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/api-keys
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token)
    • API key in header PAYMENT-SIGNATURE

Request body

namestring required
permissionsobject required

Resource → actions grant. Resources: media, sessions, projects, renders, webhooks, billing. Actions: read, write. Least-privilege — grant only what's needed (billing:write is required to start a checkout).

expiresIninteger

Lifetime in seconds; omit for no expiry.

Response

Key created — the secret is returned ONCE.

keystring required

The full secret key (cf_test_… / cf_live_…). Shown ONCE — store it now.

idstring required
prefixstring required
startstring required

First chars of the key, for later identification.

Changes

No recorded changes to this operation across all 1 revision of this API.