Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Utwórz odpowiedź modelu

Serwer:https://openapi.felo.ai
Biblioteki klienckie

Utwórz odpowiedź modelu

​

Endpoint zgodny z OpenAI Responses API. Udana odpowiedź niebędąca strumieniem ma format obiektu Responses; gdy stream=true, endpoint zwraca zdarzenia SSE Responses. Nieudany obiekt Responses może mieć status=failed z error={code,message}, nawet jeśli samo żądanie HTTP zakończyło się pomyślnie.

Nagłówki
  • X-Felo-Channel
    Typ: string

    Uporządkowane kody publicznych kanałów rozdzielone przecinkami. Pomiń ten nagłówek, aby użyć wartości domyślnej; wartość domyślna musi być używana samodzielnie. W trybie portfela wartość domyślna przegląda efektywną kolejność publicznych kanałów modelu od końca, pomija kanały nieopublikowane lub niedostępne i wybiera dostawcę pierwszego dostępnego kanału. Obejmuje dostępne endpointy tego dostawcy o tym samym identyfikatorze modelu upstream i tym samym poziomie usługi. Jawne kanały są weryfikowane w kolejności podanej przez klienta; przesyłana jest tylko grupa dostawcy pierwszego kanału. Brak automatycznego przełączania na innych dostawców. Przestarzałe nagłówki dostawcy nie mogą nadpisać routingu kanałów.

Treść·ResponsesRequest
wymagane
application/json
  • input
    wymagane
    • Typ: string
  • model
    Typ: string
    wymagane
  • include
    Typ: array string[]
  • instructions
    Typ: string
  • max_output_tokens
    Typ: integer
    min.:  
    1

    Integer numbers.

  • metadata
    Typ: object
    • propertyName
      Typ: anything
  • previous_response_id
    Typ: string
  • reasoning
    Typ: object
    • propertyName
      Typ: anything
  • service_tier
    Typ: string | null

    Obecnie obsługiwana jest tylko wartość default (standard). Pominięcie, null, aliasy i nieobsługiwane ciągi znaków powodują powrót do wartości default; inne typy zwracają HTTP 400. Skonfigurowane kanały i ceny pozostają bez zmian. Interfejsy API modeli tekstowych wysyłają standardową wartość dostawcy; interfejsy Decisions i generowania pomijają pole upstream.

  • store
    Typ: boolean
  • stream
    Typ: boolean
  • temperature
    Typ: number
    min.:  
    0
  • propertyName
    Typ: anything
  • text
    Typ: object
    • propertyName
      Typ: anything
  • tool_choice
    • Typ: string
  • tools
    Typ: array object[]
    • propertyName
      Typ: anything
  • top_p
    Typ: number
    min.:  
    0
    maks.:  
    1
  • propertyName
    Typ: anything
Odpowiedzi
  • 200
    Typ: object · ResponsesResponse

    Obiekt odpowiedzi lub zdarzenia odpowiedzi strumieniowej

    • id
      Typ: string
      wymagane
    • object
      const:  
      response
      wymagane
    • status
      Typ: string enum
      wymagane
      wartości
      • completed
      • failed
      • in_progress
      • cancelled
      • queued
      • incomplete
    • error
      Typ: object · ResponsesError
      • code
        Typ: string
        wymagane
      • message
        Typ: string
        wymagane
      • propertyName
        Typ: anything
    • metadata
      Typ: object
      • propertyName
        Typ: anything
    • model
      Typ: string
    • output
      Typ: array object[]
      • propertyName
        Typ: anything
    • output_text
      Typ: string
    • usage
      Typ: object · Usage

      Obiekt użycia dostawcy. Pola różnią się w zależności od endpointu i dostawcy.

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

    Nieprawidłowe żądanie, model lub mapowanie dostawcy

    Koperta błędu zgodna z OpenAI. Router może zwrócić code i message bez wszystkich opcjonalnych pól upstream.

    • error
      Typ: object
      wymagane
      • message
        Typ: string
        wymagane
      • code
        Typ: string | null
      • param
        Typ: string | null
      • type
        Typ: string

        Typ błędu zgodny z OpenAI, jeśli został podany.

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

    Nieprawidłowy lub brakujący klucz API Felo

    Koperta błędu zgodna z OpenAI. Router może zwrócić code i message bez wszystkich opcjonalnych pól upstream.

    • error
      Typ: object
      wymagane
      • message
        Typ: string
        wymagane
      • code
        Typ: string | null
      • param
        Typ: string | null
      • type
        Typ: string

        Typ błędu zgodny z OpenAI, jeśli został podany.

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

    Niewystarczające saldo

    Koperta błędu zgodna z OpenAI. Router może zwrócić code i message bez wszystkich opcjonalnych pól upstream.

    • error
      Typ: object
      wymagane
      • message
        Typ: string
        wymagane
      • code
        Typ: string | null
      • param
        Typ: string | null
      • type
        Typ: string

        Typ błędu zgodny z OpenAI, jeśli został podany.

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

    Konto nie ma uprawnień do korzystania z modelu. Wyłączone modele są również odrzucane przed wywołaniami upstream. Istniejące przyjęte żądania i zadania są kontynuowane.

    Koperta błędu zgodna z OpenAI. Router może zwrócić code i message bez wszystkich opcjonalnych pól upstream.

    • error
      Typ: object
      wymagane
      • message
        Typ: string
        wymagane
      • code
        Typ: string | null
      • param
        Typ: string | null
      • type
        Typ: string

        Typ błędu zgodny z OpenAI, jeśli został podany.

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

    Osiągnięto limit wydatków lub żądań

    Koperta błędu zgodna z OpenAI. Router może zwrócić code i message bez wszystkich opcjonalnych pól upstream.

    • error
      Typ: object
      wymagane
      • message
        Typ: string
        wymagane
      • code
        Typ: string | null
      • param
        Typ: string | null
      • type
        Typ: string

        Typ błędu zgodny z OpenAI, jeśli został podany.

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

    Żądanie do dostawcy upstream nie powiodło się

    Koperta błędu zgodna z OpenAI. Router może zwrócić code i message bez wszystkich opcjonalnych pól upstream.

    • error
      Typ: object
      wymagane
      • message
        Typ: string
        wymagane
      • code
        Typ: string | null
      • param
        Typ: string | null
      • type
        Typ: string

        Typ błędu zgodny z OpenAI, jeśli został podany.

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

    Dostawca lub usługa rozliczeniowa niedostępna

    Koperta błędu zgodna z OpenAI. Router może zwrócić code i message bez wszystkich opcjonalnych pól upstream.

    • error
      Typ: object
      wymagane
      • message
        Typ: string
        wymagane
      • code
        Typ: string | null
      • param
        Typ: string | null
      • type
        Typ: string

        Typ błędu zgodny z OpenAI, jeśli został podany.

      • propertyName
        Typ: anything
    • propertyName
      Typ: anything
    application/json
Request Example for post/api/v1/responses
curl https://openapi.felo.ai/api/v1/responses \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "gpt-5.5",
  "input": "Explain why the sky is blue in one sentence.",
  "stream": false
}'
{
  "id": "string",
  "object": "response",
  "status": "completed",
  "output": [
    {
      "additionalProperty": "anything"
    }
  ],
  "output_text": "string",
  "error": {
    "code": "string",
    "message": "string",
    "additionalProperty": "anything"
  },
  "usage": {
    "additionalProperty": "anything"
  },
  "model": "string",
  "metadata": {
    "additionalProperty": "anything"
  },
  "additionalProperty": "anything"
}
Create a model response