API Keys
Create API key
Create a new API key. The full key value is only returned once in this response.
POST
Authorizations
API key for authentication
Body
application/json
Human-readable name for the API key
Maximum string length:
200Example:
"Production Service Key"
Detailed description of the API key purpose
Maximum string length:
2000Example:
"Primary key for production backend service authentication"
Type of API key.
- SERVICE: Machine-to-machine authentication for backend services and integrations
- USER: User-scoped key tied to individual user actions
Available options:
SERVICE, USER Example:
"SERVICE"
Permission scopes to grant. Empty array (default) grants full access.
Permission scope. Format: resource:action, resource:*, or * for full access. Empty array [] grants full access.
Available options:
*, runs:read, runs:write, runs:*, agents:read, agents:write, agents:*, conversations:read, conversations:submit, conversations:*, metrics:read, metrics:*, test-sets:read, test-sets:write, test-sets:*, test-cases:read, test-cases:write, test-cases:*, personas:read, personas:write, personas:delete, personas:*, simulations:read, simulations:write, simulations:*, traces:read, traces:*, dashboards:read, dashboards:write, dashboards:delete, dashboards:*, api-keys:read, api-keys:write, api-keys:delete, api-keys:*, scheduled-runs:read, scheduled-runs:write, scheduled-runs:delete, scheduled-runs:*, run-templates:read, run-templates:write, run-templates:delete, run-templates:*, reports:read, reports:write, reports:delete, reports:* Example:
[]Response
API key created successfully
API key resource with full key value. Only returned during creation.

