Create a text response

Recommended OpenAI-compatible surface for reasoning, tools, structured outputs, and streaming.

Authentication

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

OR
x-api-keystring

Anthropic-compatible API key header. Use a BeatAPI API key.

Request

This endpoint expects an object.
modelstringRequired

Public text model id exposed by BeatAPI. Call GET /v1/models to discover the models enabled for your environment.

Response

OpenAI-compatible JSON response or server-sent event stream

Errors

401
Unauthorized Error
402
Payment Required Error
429
Too Many Requests Error
502
Bad Gateway Error
503
Service Unavailable Error