v0.4.0

OpenAPI 3.1.0

Vytvořit dokončení chatu

Felo API Support

MIT

Server

https://openapi.felo.ai

Klientské knihovny

Shell Curl

Vytvořit dokončení chatu

Rozhraní Chat Completions kompatibilní s OpenAI. Nastavením stream=true získáte Server-Sent Events. Odpověď a obálka chyb odpovídají formátu Chat Completions kompatibilnímu s OpenAI.

Hlavičky

X-Felo-Channel
Typ: string

Seřazené kódy veřejných kanálů oddělené čárkami. Pokud tuto hlavičku vynecháte, použije se default; default lze použít pouze samostatně. V režimu peněženky prochází default efektivní pořadí veřejných kanálů modelu v opačném směru, přeskakuje nepublikované nebo nedostupné kanály a vybere poskytovatele prvního dostupného kanálu. Zahrnuje dostupné endpointy tohoto poskytovatele se stejným ID modelu v upstreamu a stejnou úrovní služby. Explicitní kanály se ověřují v pořadí zadaném klientem; odešle se pouze skupina poskytovatele prvního kanálu. K automatickému přepnutí na jiné poskytovatele nedochází. Starší hlavičky poskytovatele nemohou přepsat směrování kanálů.

Tělo·ChatCompletionRequest

povinné

application/json

messages
Typ: array object[] · ChatMessage[] 1…
povinné
- content
  může být null
  povinné
  Typ: string
- role
  Typ: string enum
  povinné
  hodnoty
  system
  developer
  user
  assistant
  tool
- name
  Typ: string
- tool_call_id
  Typ: string
- tool_calls
  Typ: array object[]
  propertyName
  Typ: anything
- propertyName
  Typ: anything
model
Typ: string
povinné
max_completion_tokens
Typ: integer
min:
1

Integer numbers.
max_tokens
Typ: integer
min:
1

Integer numbers.
n
Typ: integer
min:
1

Integer numbers.
response_format
Typ: object
- propertyName
  Typ: anything
service_tier
Typ: string | null

V současnosti je podporována pouze hodnota default (standard). Vynechaná hodnota, null, aliasy a nepodporované řetězce se převedou na default; jiné typy vrací HTTP 400. Nakonfigurované kanály a ceny zůstávají beze změny. Textová API odesílají standardní hodnotu poskytovatele; rozhraní Decisions a rozhraní generování pole upstreamu vynechávají.
stop
může být null
Typ: string
stream
Typ: boolean
temperature
Typ: number
min:
0
tool_choice
Typ: string
tools
Typ: array object[]
- propertyName
  Typ: anything
propertyName
Typ: anything

top_p
Typ: number
min:
0
max:
1
user
Typ: string
propertyName
Typ: anything

Odpovědi

200
Typ: object · ChatCompletionResponse

Dokončení chatu nebo streamovaná odpověď
choices
Typ: array object[] · ChatChoice[]
povinné
finish_reason
Typ: string | null
index
Typ: integer

Integer numbers.

logprobs
Typ: object | null
propertyName
Typ: anything
message
Typ: object · ChatMessage
content
může být null
povinné
Typ: string
role
Typ: string enum
povinné
hodnoty
system
developer
user
assistant
tool
name
Typ: string
tool_call_id
Typ: string
tool_calls
Typ: array object[]
propertyName
Typ: anything
propertyName
Typ: anything
propertyName
Typ: anything
id
Typ: string
povinné
object
Typ: string
povinné

Obvykle chat.completion u nestreamovaných odpovědí.

created
Typ: integer Formát: int64

Signed 64-bit integers (long type).

model
Typ: string
system_fingerprint
Typ: string
usage
Typ: object · Usage

Objekt využití od poskytovatele. Pole se liší podle endpointu a poskytovatele.

propertyName
Typ: anything
propertyName
Typ: anything
400
Typ: object · OpenAIErrorResponse

Neplatný požadavek, model nebo mapování poskytovatele

Obálka chyb kompatibilní s OpenAI. Router může obsahovat code a message bez všech volitelných polí upstreamu.
error
Typ: object
povinné
message
Typ: string
povinné
code
Typ: string | null
param
Typ: string | null
type
Typ: string

Typ chyby kompatibilní s OpenAI, je-li uveden.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
401
Typ: object · OpenAIErrorResponse

Neplatný nebo chybějící API klíč Felo

Obálka chyb kompatibilní s OpenAI. Router může obsahovat code a message bez všech volitelných polí upstreamu.
error
Typ: object
povinné
message
Typ: string
povinné
code
Typ: string | null
param
Typ: string | null
type
Typ: string

Typ chyby kompatibilní s OpenAI, je-li uveden.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
402
Typ: object · OpenAIErrorResponse

Nedostatečný zůstatek

Obálka chyb kompatibilní s OpenAI. Router může obsahovat code a message bez všech volitelných polí upstreamu.
error
Typ: object
povinné
message
Typ: string
povinné
code
Typ: string | null
param
Typ: string | null
type
Typ: string

Typ chyby kompatibilní s OpenAI, je-li uveden.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
403
Typ: object · OpenAIErrorResponse

Účet nemá oprávnění model používat. Zakázané modely se odmítají ještě před voláním upstreamu. Již přijaté požadavky a úlohy pokračují.

Obálka chyb kompatibilní s OpenAI. Router může obsahovat code a message bez všech volitelných polí upstreamu.
error
Typ: object
povinné
message
Typ: string
povinné
code
Typ: string | null
param
Typ: string | null
type
Typ: string

Typ chyby kompatibilní s OpenAI, je-li uveden.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
429
Typ: object · OpenAIErrorResponse

Dosažen limit utrácení nebo požadavků

Obálka chyb kompatibilní s OpenAI. Router může obsahovat code a message bez všech volitelných polí upstreamu.
error
Typ: object
povinné
message
Typ: string
povinné
code
Typ: string | null
param
Typ: string | null
type
Typ: string

Typ chyby kompatibilní s OpenAI, je-li uveden.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
502
Typ: object · OpenAIErrorResponse

Požadavek na poskytovatele upstream selhal

Obálka chyb kompatibilní s OpenAI. Router může obsahovat code a message bez všech volitelných polí upstreamu.
error
Typ: object
povinné
message
Typ: string
povinné
code
Typ: string | null
param
Typ: string | null
type
Typ: string

Typ chyby kompatibilní s OpenAI, je-li uveden.

propertyName
Typ: anything
propertyName
Typ: anything
application/json
503
Typ: object · OpenAIErrorResponse

Poskytovatel nebo fakturační služba nejsou dostupné

Obálka chyb kompatibilní s OpenAI. Router může obsahovat code a message bez všech volitelných polí upstreamu.
error
Typ: object
povinné
message
Typ: string
povinné
code
Typ: string | null
param
Typ: string | null
type
Typ: string

Typ chyby kompatibilní s OpenAI, je-li uveden.

propertyName
Typ: anything
propertyName
Typ: anything
application/json

post/api/v1/chat/completions

curl https://openapi.felo.ai/api/v1/chat/completions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "gpt-5.5",
  "messages": [
    {
      "role": "user",
      "content": "Write a one-sentence greeting."
    }
  ],
  "stream": false
}'

Zobrazit schéma

{
  "id": "string",
  "object": "string",
  "created": 1,
  "model": "string",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "string",
        "name": "string",
        "tool_call_id": "string",
        "tool_calls": [
          {
            "additionalProperty": "anything"
          }
        ],
        "additionalProperty": "anything"
      },
      "finish_reason": null,
      "logprobs": null,
      "additionalProperty": "anything"
    }
  ],
  "usage": {
    "additionalProperty": "anything"
  },
  "system_fingerprint": "string",
  "additionalProperty": "anything"
}

Dokončení chatu nebo streamovaná odpověď

Vytvořit dokončení chatu

OvěřováníRequired

Vytvořit dokončení chatu