API keys
/keysList a brand's Brand API keys. Display prefixes only — the key itself is never returned.
Authorization
sessionBearerAuth Dashboard session access token (NOT a Brand Data API key), sent as Authorization: Bearer <session-token>. Used only for the /keys key-management routes.
In: header
Query Parameters
Brand to mint for. Defaults to the session’s own brand.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/keys"{ "data": [ { "id": "string", "keyPrefix": "string", "brandId": "string", "createdAt": "string", "lastUsedAt": "string", "revokedAt": "string" } ]}{ "error": "string"}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}/keysMint a Brand Data API key for a brand. Authenticated by a dashboard session, never by an API key. The plaintext key is returned exactly once and cannot be retrieved again.
Authorization
sessionBearerAuth Dashboard session access token (NOT a Brand Data API key), sent as Authorization: Bearer <session-token>. Used only for the /keys key-management routes.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/keys" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "string", "keyPrefix": "string", "brandId": "string", "createdAt": "string", "lastUsedAt": "string", "revokedAt": "string", "plaintext": "string" }}{ "error": "string"}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}/keys/{keyId}Revoke one key by its unique id. Idempotent: an unknown or already-revoked key 404s.
Authorization
sessionBearerAuth Dashboard session access token (NOT a Brand Data API key), sent as Authorization: Bearer <session-token>. Used only for the /keys key-management routes.
In: header
Path Parameters
The key’s unique id (from the list endpoint). Revoking targets exactly this key — the display prefix is non-unique and would revoke every key that shares it.
Query Parameters
Brand to mint for. Defaults to the session’s own brand.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/keys/string"{ "data": [ { "id": "string", "keyPrefix": "string", "brandId": "string", "createdAt": "string", "lastUsedAt": "string", "revokedAt": "string" } ]}{ "error": "string"}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}