Skip to main content
POST
Get an Access Token

Body

application/json

OAuth2 client-credentials token exchange request.

client_id
string
required

Client identifier issued during onboarding.

Required string length: 5 - 120
Example:

"cl_aBcDeFgHiJkLmNoPqRsTuV"

client_secret
string
required

Client secret issued during onboarding. Shown only once at creation or rotation.

Required string length: 10 - 255
Example:

"sk_aBcDeFgHiJkLmNoPqRsTuVwXyZaBcDeFgHiJkLmNoPqRsTuVwXyZ"

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.