Create a text response | BeatAPI API Documentation

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

AuthorizationBearer

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

x-api-keystring

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

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.

OpenAI-compatible JSON response or server-sent event stream

401

Unauthorized Error

402

Payment Required Error

429

Too Many Requests Error

502

Bad Gateway Error

503

Service Unavailable Error

$	curl -X POST https://api.beatapi.io/v1/responses \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"model": "gemini-3.1-pro-preview",
>	"input": "Design a resilient webhook retry strategy for a payments API.",
>	"reasoning": {
>	"effort": "medium"
>	},
>	"stream": true
>	}'