Saltar para o conteúdo principal
POST
/
chat
/
completions
curl --request POST \
  --url https://api.orcarouter.ai/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "openai/gpt-4o-mini",
  "messages": [
    {
      "role": "user",
      "content": "Say hi in one word."
    }
  ],
  "max_tokens": 10
}
'
{
  "id": "<string>",
  "created": 123,
  "model": "<string>",
  "choices": [
    {
      "index": 123,
      "message": {
        "content": "<string>",
        "name": "<string>",
        "tool_calls": [
          {
            "id": "<string>",
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            }
          }
        ],
        "tool_call_id": "<string>"
      }
    }
  ],
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123
  }
}

Autorizações

​
Authorization
string
header
obrigatório

As chaves de API do OrcaRouter têm o formato sk-orca-.... Passe-as no cabeçalho Authorization: Bearer sk-orca-....

Corpo

application/json
​
model
string
obrigatório

ID do modelo. Suporta três formas:

  • Com prefixo de provedor (padrão): openai/gpt-4o-mini, anthropic/claude-sonnet-4.6, google/gemini-2.5-flash
  • Alias simples: gpt-4o-mini (quando um alias de nome puro está disponível)
  • Roteador nomeado: orcarouter/{name} (resolve para um modelo no momento da requisição; orcarouter/auto é semeado no cadastro para toda conta e escolhe o modelo de chat ativo mais barato)
Exemplos:

"gpt-4o"

"openai/gpt-4o"

"orcarouter/auto"

​
messages
object[]
obrigatório
​
stream
boolean

Quando true, a resposta é transmitida como server-sent events.

​
stream_options
object

Aplica-se apenas quando stream: true.

​
tools
object[]
​
tool_choice
Opções disponíveis:
auto,
none,
required
​
parallel_tool_calls
boolean
padrão:true
​
response_format
Texto (padrão) · object
​
temperature
number
Intervalo necessário: 0 <= x <= 2
​
top_p
number
Intervalo necessário: 0 <= x <= 1
​
max_tokens
integer
Intervalo necessário: x >= 1
​
max_completion_tokens
integer

Preferido sobre max_tokens para modelos de raciocínio.

​
n
integer
padrão:1
Intervalo necessário: x >= 1
​
stop
​
seed
integer

Para amostragem determinística.

​
logprobs
boolean
​
top_logprobs
integer
Intervalo necessário: 0 <= x <= 20
​
presence_penalty
number
Intervalo necessário: -2 <= x <= 2
​
frequency_penalty
number
Intervalo necessário: -2 <= x <= 2
​
logit_bias
object
​
user
string
​
reasoning_effort
enum<string>

Para modelos de raciocínio da OpenAI (o1, o3*, o4*, gpt-5*-pro, etc.). Anthropic Claude usa o campo thinking em vez disso; o Gemini usa configuração específica do provedor.

Opções disponíveis:
low,
medium,
high
​
web_search_options
object

Habilita busca web em uma requisição Chat Completions. A Responses API usa tools: [{"type": "web_search"}] em vez disso. Honrada por modelos OpenAI search-preview, modelos OpenAI que aceitam a ferramenta moderna web_search e modelos Anthropic (traduzido para a ferramenta de servidor nativa web_search da Anthropic).

​
web_search
any

Carga útil bruta de forma livre encaminhada para a ferramenta de busca web do upstream quando web_search_options não é expressiva o suficiente. A maioria dos usuários deve preferir web_search_options.

​
extra_body
object

Extensões de requisição específicas do OrcaRouter. Coloque-as sob a chave de nível superior extra_body da sua requisição de chat completion.

Resposta

Completion bem-sucedido. Respostas com streaming usam SSE (text/event-stream).

​
id
string
​
object
enum<string>
Opções disponíveis:
chat.completion
​
created
integer
​
model
string
​
choices
object[]
​
usage
object