Chat Completions

Creates a model response for a chat conversation. This endpoint accepts OpenAI-compatible chat payloads and adds JoyToken routing, policy, wallet, and usage metadata around the provider call.

Authentication

AuthorizationBearer

Use Authorization: Bearer $JOY_TOKEN_API_KEY.

Headers

X-API-KeystringOptional
Compatibility API key header. Prefer Authorization Bearer for new integrations.

Request

This endpoint expects an object.
messageslist of objectsRequired

OpenAI-compatible chat messages.

modelstringOptional

Model ID. Use auto or omit to let JoyToken route automatically.

tierenumOptional
JoyToken model tier.
streambooleanOptionalDefaults to false

Return an OpenAI-compatible SSE stream when true.

temperaturedoubleOptional0-2
Sampling temperature forwarded to the selected provider when supported.
top_pdoubleOptional0-1
Nucleus sampling value forwarded to the selected provider when supported.
max_tokensintegerOptional>=1
Maximum output tokens. Also participates in JoyToken billing estimation.
userstringOptional

Optional end-user identifier used as route session context.

toolslist of objectsOptional

OpenAI-compatible tool definitions.

Response headers

X-DAOE-Used-Modelstring
The final model selected by JoyToken routing.
X-DAOE-Used-Providerstring
The provider that served the request.
X-DAOE-Failoverstring
Present on streaming responses when provider failover occurred.

Response

Successful chat completion response.
idstring
objectstring
choiceslist of objects
createdlong
modelstring
usageobject
metadataobject
JoyToken routing and billing metadata appended by the gateway when available.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error