Create an API key
Create an API key and return its complete value exactly once.
Endpoint
POST
/api/v1/workspaces/{workspace_id}/api-keysAuthentication
| Operation class | Authentication | Minimum role | API key |
|---|---|---|---|
| dashboard-session-api | Dashboard session cookie; mutations also require X-CX-Request: 1. | admin | Not allowed |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
workspace_id | path | string | Yes | — |
Request body
application/json request schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | PermintaanKunci | — | No | Yes | — | — |
name | string | — | — | No | Yes | — | — |
Example
curl --request POST 'https://operade.ai/api/v1/workspaces/ws_demo/api-keys' \
--cookie 'cx_session=YOUR_SESSION_COOKIE' \
--header 'X-CX-Request: 1' \
--header 'Content-Type: application/json' \
--data '{"name":"Example reporting key"}'{
"name": "Example reporting key"
}Responses
| Status | Description | Content |
|---|---|---|
4XX | Handled client error | application/json: ErrorResponse |
201 | Successful Response | application/json: ApiKeyCreateResponse |
4XX application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | ErrorResponse | — | No | Yes | — | — |
error | object | ErrorItem | — | No | Yes | — | — |
error.code | string | — | — | No | Yes | — | — |
error.details | object | — | — | No | No | — | — |
error.message | string | — | — | No | Yes | — | — |
201 application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | ApiKeyCreateResponse | — | No | Yes | — | — |
id | string | — | — | No | Yes | — | — |
key | string | — | — | No | Yes | — | — |
name | string | — | — | No | Yes | — | — |
prefix | string | — | — | No | Yes | — | — |
Response example
{
"id": "string",
"name": "string",
"prefix": "string",
"key": "string"
}Errors
Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.
| Status | Code | Description |
|---|---|---|
401 | unauthenticated | Authentication is missing, invalid, or revoked. |
403 | forbidden | The authenticated caller does not have access to this operation. |
404 | not_found | The requested workspace resource was not found. |
422 | validation_failed | The request did not pass field or business validation. |