Sign in
Agents

Manage agent API key

Create, rotate, revoke, or delete the agent's API key. Each agent can have only one API key at a time.

post/v0.2.4/agents/api-key

Request body

agentIdstring required

Agent UID

subAccountstring

Sub-account identifier

action'create' | 'rotate' | 'revoke' | 'delete' | 'update-webhook' required
  • create: Generate initial API key
  • rotate: Replace existing key with new one
  • revoke: Mark key as revoked (keeps record, blocks usage)
  • delete: Permanently remove the key
  • update-webhook: Update webhook URL only
appNamestring

Name for the API key (required for create/rotate)

webhookUrlstring uri

Webhook URL for agent events (optional for create/rotate, required for update-webhook)

Example request

{
  "agentId": "abc123-def456-ghi789",
  "appName": "My Agent App",
  "webhookUrl": "https://example.com/webhook"
}

Response

Operation successful

statusstring
messagestring

Example response

{
  "status": "success"
}

Changes

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