Skip to content

Generate API Token

POST
/api/v1/auth/token
curl --request POST \
--url https://example.com/api/v1/auth/token \
--header 'Content-Type: application/json' \
--data '{ "client_id": "example", "client_secret": "example" }'
Media typeapplication/json
ClientTokenRequest
object
client_id
required
Client Id
string
client_secret
required
Client Secret
string
Examplegenerated
{
"client_id": "example",
"client_secret": "example"
}

Successful Response

Media typeapplication/json
TokenResponse
object
access_token
required
Access Token
string
token_type
Token Type
string
default: Bearer
expires_in
required
Expires In
integer
workspace
required
Workspace
string
Example
{
"token_type": "Bearer"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}