Create Api Key
POST
/api/v1/api-keys
Generate a new API key for the authenticated user.
The raw key is returned once and cannot be retrieved later.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” ApiKeyCreateRequest
Request body for creating a new API key.
object
name
required
Name
A human-readable label for the API key.
string
Responses
Section titled “ Responses ”Successful Response
ApiKeyCreateResultResponse
Response for POST /api/v1/api-keys.
object
success
required
Success
boolean
data
Any of:
ApiKeyCreateData
Data returned when a new key is created (includes raw key).
object
id
required
Id
string
name
required
Name
string
key
required
Key
The raw API key. Shown once — cannot be retrieved later.
string
prefix
required
Prefix
string
created_at
required
Created At
string
null
error
Any of:
ErrorDetail
null
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context