v4

latestOpenAPI 3.1.02026-08-019681,1012.0 MB

api_keys

Create Api Key

post/users/api_keys

Request body

descriptionstring required

expires_atstring date-time nullable

Expiry date for the API key

project_idstring uuid4 nullable

project_role'owner' | 'editor' | 'annotator' | 'viewer'

api_keystring nullable

Optional pre-generated API key value. If not provided, one will be generated automatically. This is used for setups where the same API key needs to exist on multiple clusters.

Response

Successful Response

idstring uuid4 required

descriptionstring required

expires_atstring date-time nullable

created_atstring date-time required

updated_atstring date-time required

last_usedstring date-time nullable

project_idstring uuid4 nullable

project_role'owner' | 'editor' | 'annotator' | 'viewer'

created_bystring uuid4 required

truncatedstring required

api_keystring required