Create API key
POST
/v1/admin/keysHow to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Human-readable name. |
| description | string | No | Human-readable description. |
| prefix | string | No | — |
| keyType | standard | internal | No | — |
| userId | string | No | User ID. |
| expiresIn | integer | No | Expiration window in days. |
| scopes | string[] | No | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201API key createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | No | Unique identifier. |
| keyPrefix | string | No | — |
| keyType | standard | internal | No | — |
| name | string | No | Human-readable name. |
| description | string | No | Human-readable description. |
| userId | string | No | User ID. |
| createdAt | string | No | ISO 8601 timestamp. |
| lastUsedAt | string | No | ISO 8601 timestamp. |
| expiresAt | string | No | — |
| isActive | boolean | No | — |
| scopes | string[] | No | — |
| metadata | object | No | Free-form metadata object. |
| key | string | No | Plaintext API key. Returned exactly once at creation time. |
| warning | string | No | — |