Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Een chatcompletion aanmaken

Server:https://openapi.felo.ai
Clientbibliotheken

Een chatcompletion aanmaken

​

OpenAI-compatibele Chat Completions-API. Stel stream=true in om Server-Sent Events te ontvangen. De respons en de foutenvelop volgen de vorm van Chat Completions/OpenAI-compatibel.

Headers
  • X-Felo-Channel
    Type: string

    Geordende, door komma's gescheiden openbare kanaalcodes. Laat deze header weg om default te gebruiken; default moet alleen worden gebruikt. In walletmodus scant default de effectieve openbare kanaalvolgorde van het model in omgekeerde volgorde, slaat niet-gepubliceerde of niet-beschikbare kanalen over en kiest de aanbieder van het eerste beschikbare kanaal. Het omvat beschikbare endpoints van die aanbieder met hetzelfde upstream-model-ID en hetzelfde serviceniveau. Expliciete kanalen worden gevalideerd in de door de client opgegeven volgorde; alleen de aanbiedergroep van het eerste kanaal wordt ingediend. Geen automatische fallback naar andere aanbieders. Verouderde providerheaders kunnen de kanaalroutering niet overschrijven.

Body·ChatCompletionRequest
verplicht
application/json
  • messages
    Type: array object[] · ChatMessage[] 1…
    verplicht
    • content
      null toegestaan
      verplicht
      • Type: string
    • role
      Type: string enum
      verplicht
      waarden
      • system
      • developer
      • user
      • assistant
      • tool
    • name
      Type: string
    • tool_call_id
      Type: string
    • tool_calls
      Type: array object[]
      • propertyName
        Type: anything
    • propertyName
      Type: anything
  • model
    Type: string
    verplicht
  • max_completion_tokens
    Type: integer
    min.:  
    1

    Integer numbers.

  • max_tokens
    Type: integer
    min.:  
    1

    Integer numbers.

  • n
    Type: integer
    min.:  
    1

    Integer numbers.

  • response_format
    Type: object
    • propertyName
      Type: anything
  • service_tier
    Type: string | null

    Momenteel wordt alleen default (standaard) ondersteund. Weggelaten, null, aliassen en niet-ondersteunde tekenreeksen vallen terug op default; andere typen retourneren HTTP 400. Geconfigureerde kanalen en prijzen blijven ongewijzigd. Tekst-API's sturen de standaardwaarde van de aanbieder; Decisions- en generatie-API's laten het upstream-veld weg.

  • stop
    null toegestaan
    • Type: string
  • stream
    Type: boolean
  • temperature
    Type: number
    min.:  
    0
  • tool_choice
    • Type: string
  • tools
    Type: array object[]
    • propertyName
      Type: anything
  • propertyName
    Type: anything
  • top_p
    Type: number
    min.:  
    0
    max.:  
    1
  • user
    Type: string
  • propertyName
    Type: anything
Responsen
  • 200
    Type: object · ChatCompletionResponse

    Chatcompletion of streamingrespons

    • choices
      Type: array object[] · ChatChoice[]
      verplicht
      • finish_reason
        Type: string | null
      • index
        Type: integer

        Integer numbers.

      • logprobs
        Type: object | null
        • propertyName
          Type: anything
      • message
        Type: object · ChatMessage
        • content
          null toegestaan
          verplicht
          • Type: string
        • role
          Type: string enum
          verplicht
          waarden
          • system
          • developer
          • user
          • assistant
          • tool
        • name
          Type: string
        • tool_call_id
          Type: string
        • tool_calls
          Type: array object[]
          • propertyName
            Type: anything
        • propertyName
          Type: anything
      • propertyName
        Type: anything
    • id
      Type: string
      verplicht
    • object
      Type: string
      verplicht

      Meestal chat.completion voor niet-streamingresponsen.

    • created
      Type: integer Formaat: int64

      Signed 64-bit integers (long type).

    • model
      Type: string
    • system_fingerprint
      Type: string
    • usage
      Type: object · Usage

      Gebruiksobject van de aanbieder. Velden verschillen per endpoint en aanbieder.

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

    Ongeldig verzoek, model of aanbiedermapping

    OpenAI-compatibele foutenvelop. De Router kan code en message opnemen zonder alle optionele upstream-velden.

    • error
      Type: object
      verplicht
      • message
        Type: string
        verplicht
      • code
        Type: string | null
      • param
        Type: string | null
      • type
        Type: string

        OpenAI-compatibel fouttype, indien opgegeven.

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

    Ongeldige of ontbrekende Felo API-sleutel

    OpenAI-compatibele foutenvelop. De Router kan code en message opnemen zonder alle optionele upstream-velden.

    • error
      Type: object
      verplicht
      • message
        Type: string
        verplicht
      • code
        Type: string | null
      • param
        Type: string | null
      • type
        Type: string

        OpenAI-compatibel fouttype, indien opgegeven.

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

    Onvoldoende saldo

    OpenAI-compatibele foutenvelop. De Router kan code en message opnemen zonder alle optionele upstream-velden.

    • error
      Type: object
      verplicht
      • message
        Type: string
        verplicht
      • code
        Type: string | null
      • param
        Type: string | null
      • type
        Type: string

        OpenAI-compatibel fouttype, indien opgegeven.

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

    Het account mag het model niet gebruiken. Uitgeschakelde modellen worden ook vóór upstream-aanroepen geweigerd. Bestaande geaccepteerde verzoeken en taken lopen door.

    OpenAI-compatibele foutenvelop. De Router kan code en message opnemen zonder alle optionele upstream-velden.

    • error
      Type: object
      verplicht
      • message
        Type: string
        verplicht
      • code
        Type: string | null
      • param
        Type: string | null
      • type
        Type: string

        OpenAI-compatibel fouttype, indien opgegeven.

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

    Limiet voor bestedingen of verzoeken bereikt

    OpenAI-compatibele foutenvelop. De Router kan code en message opnemen zonder alle optionele upstream-velden.

    • error
      Type: object
      verplicht
      • message
        Type: string
        verplicht
      • code
        Type: string | null
      • param
        Type: string | null
      • type
        Type: string

        OpenAI-compatibel fouttype, indien opgegeven.

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

    Verzoek aan upstream-aanbieder mislukt

    OpenAI-compatibele foutenvelop. De Router kan code en message opnemen zonder alle optionele upstream-velden.

    • error
      Type: object
      verplicht
      • message
        Type: string
        verplicht
      • code
        Type: string | null
      • param
        Type: string | null
      • type
        Type: string

        OpenAI-compatibel fouttype, indien opgegeven.

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

    Aanbieder of factureringsdienst niet beschikbaar

    OpenAI-compatibele foutenvelop. De Router kan code en message opnemen zonder alle optionele upstream-velden.

    • error
      Type: object
      verplicht
      • message
        Type: string
        verplicht
      • code
        Type: string | null
      • param
        Type: string | null
      • type
        Type: string

        OpenAI-compatibel fouttype, indien opgegeven.

      • propertyName
        Type: anything
    • propertyName
      Type: anything
    application/json
Request Example for 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
}'
{
  "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"
}
Create a chat completion