latestOpenAPI 3.0.32026-08-2142130334.7 KB

0a94056fba48

API Keys

Issue an API key

Issues an exact-scope credential for an existing workspace member or a new named agent. Requires api_keys:write, a live admin/owner membership, and an Idempotency-Key. The encrypted secret response is replayable for 24 hours; after that it cannot be recovered. Credential-management scopes cannot be delegated.

post/api-keys

Headers

Idempotency-Keystring required

Idempotency key.

Required key for safe retries. Reusing it with different parameters returns 409 idempotency_conflict. The encrypted secret response can be replayed for 24 hours.

Request body

namestring nullable required

Optional operator-facing key label.

scopesstring[] required

Exact non-administrative scopes to grant.

Example request

{
  "subject": {
    "workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
  }
}

Response

Issued API key.

Example response

{
  "data": {
    "key": {
      "id": "01jzn7e61x3a7v9h2r7t2m3q4p",
      "subject": {
        "workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
      }
    }
  }
}