v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-016280256.4 KB

api-keys

Create API key

Creates a new API key for the current user

post/api/api-keys/

Request body

namestring required

actionsGrantAction[] required

Action verbs the key may perform (at least one). read is required whenever any broader action is selected. Pass all four actions for a full-access key.

library_scope_mode'all_libraries' | 'selected_libraries' required

Which of the owner's libraries a grant covers.

all_libraries means all current and future live libraries owned by the grant's user. selected_libraries means only the libraries listed in access_grant_libraries, with no automatic expansion.

library_idsstring[] nullable

Libraries the key covers. Required (at least one) when library_scope_mode is selected_libraries; not allowed otherwise. Up to 200 ids.

Response

Successful Response

idstring required

Unique API key identifier with 'apikey_' prefix

namestring nullable

Optional descriptive name for this API key

created_atstring date-time required

When this API key was created

last_used_atstring date-time nullable

When this API key was last used for authentication

is_activeboolean required

Whether this API key is currently valid and can be used

actionsGrantAction[] nullable

Action verbs this key's grant allows; null for legacy keys

library_scope_mode'all_libraries' | 'selected_libraries'

Which of the owner's libraries a grant covers.

all_libraries means all current and future live libraries owned by the grant's user. selected_libraries means only the libraries listed in access_grant_libraries, with no automatic expansion.

selected_library_countinteger nullable

Number of libraries a 'selected_libraries' grant covers; null unless library_scope_mode is 'selected_libraries'

api_keystring required

The actual API key value - store this securely as it cannot be retrieved later