BEATRICE Docs
Sections

API reference

Generated from the API's OpenAPI spec (the public /v1 part only). Base URL: https://api.beatriceai.it. For usage details see the pages of the API section.

Download openapi.json

GET /v1/models

List available models

200 response

NameTypeNotes
objectstring
dataobject[]

GET /v1/models/{model}

Retrieve a model

Parameters

NameTypeNotes
model (path)stringrequired

200 response

NameTypeNotes
idstring
objectstring
createdinteger
owned_bystring

POST /v1/chat/completions

Create a chat completion (OpenAI compatible, streaming supported)

OpenAI chat completions format. The answer may carry reasoning_content next to content; usage counts reasoning in completion_tokens. A red-line refusal is a normal answer with finish_reason: "content_filter".

Request body

Also forwarded: stop, presence_penalty, frequency_penalty, seed, response_format, tools, tool_choice, parallel_tool_calls, logprobs, top_logprobs. A null optional field means not set. Other fields are ignored.

NameTypeNotes
modelstringrequired. Model id, e.g. beatrice-flash (GET /v1/models)
messagesobject[]required. The conversation so far
streambooleanSend the answer as server-sent events
stream_optionsobject
max_tokensintegerOutput limit, reasoning included; default 8192 plus the reasoning budget of the level · ≥ 1
max_completion_tokensintegerSame as max_tokens (newer OpenAI name) · ≥ 1
nintegerOnly 1 is supported · ≥ 1
temperaturenumber≥ 0, ≤ 2
top_pnumber≥ 0, ≤ 1
reasoning_effortstringHow long the model reasons before answering: none (no reasoning; minimal is the same), low (the default, up to 2048 reasoning tokens), medium (up to 8192), high (up to 16384; xhigh is the same). On plans without reasoning (Free) every answer is none.
reasoning_budget_tokensintegerAt most this many reasoning tokens, below the level's own cap (never above it); 0 means no reasoning. For agents that spread one task over many requests. · ≥ 0
stopany
presence_penaltynumber≥ -2, ≤ 2
frequency_penaltynumber≥ -2, ≤ 2
seedinteger≥ -9007199254740991, ≤ 9007199254740991
logprobsboolean
top_logprobsinteger≥ 0, ≤ 20
parallel_tool_callsboolean
toolsobject[]
tool_choiceany
response_formatobject

l'amor che move il sole e l'altre stelle