Przejdź do głównej treści
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
  }
}

Autoryzacje

​
Authorization
string
header
wymagane

Klucze API OrcaRouter wyglądają jak sk-orca-.... Przekaż je w nagłówku Authorization: Bearer sk-orca-....

Treść

application/json
​
model
string
wymagane

Identyfikator modelu. Obsługuje trzy formy:

  • Z prefiksem dostawcy (domyślnie): openai/gpt-4o-mini, anthropic/claude-sonnet-4.6, google/gemini-2.5-flash
  • Zwykły alias: gpt-4o-mini (gdy alias bez prefiksu jest dostępny)
  • Nazwany router: orcarouter/{name} (rozwija się do modelu w czasie żądania; orcarouter/auto jest zasiany przy rejestracji dla każdego konta i wybiera najtańszy dostępny model chat)
Przykłady:

"gpt-4o"

"openai/gpt-4o"

"orcarouter/auto"

​
messages
object[]
wymagane
​
stream
boolean

Gdy true, odpowiedź jest strumieniowana jako server-sent events.

​
stream_options
object

Stosowane tylko gdy stream: true.

​
tools
object[]
​
tool_choice
Dostępne opcje:
auto,
none,
required
​
parallel_tool_calls
boolean
domyślnie:true
​
response_format
Tekst (domyślnie) · object
​
temperature
number
Wymagany zakres: 0 <= x <= 2
​
top_p
number
Wymagany zakres: 0 <= x <= 1
​
max_tokens
integer
Wymagany zakres: x >= 1
​
max_completion_tokens
integer

Preferowane nad max_tokens dla modeli reasoning.

​
n
integer
domyślnie:1
Wymagany zakres: x >= 1
​
stop
​
seed
integer

Dla deterministycznego samplowania.

​
logprobs
boolean
​
top_logprobs
integer
Wymagany zakres: 0 <= x <= 20
​
presence_penalty
number
Wymagany zakres: -2 <= x <= 2
​
frequency_penalty
number
Wymagany zakres: -2 <= x <= 2
​
logit_bias
object
​
user
string
​
reasoning_effort
enum<string>

Dla modeli reasoning OpenAI (o1, o3*, o4*, gpt-5*-pro itd.). Anthropic Claude używa zamiast tego pola thinking; Gemini używa konfiguracji specyficznej dla dostawcy.

Dostępne opcje:
low,
medium,
high
​
web_search_options
object

Włącz web search w żądaniu Chat Completions. Responses API używa zamiast tego tools: [{"type": "web_search"}]. Honorowane przez modele search-preview OpenAI, modele OpenAI akceptujące nowoczesne narzędzie web_search oraz modele Anthropic (tłumaczone na natywne server-tool web_search Anthropic).

​
web_search
any

Wolnoformatowy surowy payload przekazywany do narzędzia web-search upstreamu, gdy web_search_options jest niewystarczające. Większość użytkowników powinna preferować web_search_options.

​
extra_body
object

Rozszerzenia żądania specyficzne dla OrcaRouter. Umieść je pod kluczem najwyższego poziomu extra_body Twojego żądania chat completion.

Odpowiedź

Pomyślne completion. Odpowiedzi streamingowe używają SSE (text/event-stream).

​
id
string
​
object
enum<string>
Dostępne opcje:
chat.completion
​
created
integer
​
model
string
​
choices
object[]
​
usage
object