Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Een modelrespons aanmaken

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

Een modelrespons aanmaken

​

Endpoint compatibel met de OpenAI Responses API. Een geslaagde niet-streamingrespons gebruikt de vorm van het Responses-object; bij stream=true retourneert het endpoint Responses-SSE-events. Een mislukt Responses-object kan status=failed met error={code,message} gebruiken, zelfs wanneer het HTTP-verzoek zelf is voltooid.

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·ResponsesRequest
verplicht
application/json
  • input
    verplicht
    • Type: string
  • model
    Type: string
    verplicht
  • include
    Type: array string[]
  • instructions
    Type: string
  • max_output_tokens
    Type: integer
    min.:  
    1

    Integer numbers.

  • metadata
    Type: object
    • propertyName
      Type: anything
  • previous_response_id
    Type: string
  • reasoning
    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.

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

    Responsobject of streamingresponse-events

    • id
      Type: string
      verplicht
    • object
      constante:  
      response
      verplicht
    • status
      Type: string enum
      verplicht
      waarden
      • completed
      • failed
      • in_progress
      • cancelled
      • queued
      • incomplete
    • error
      Type: object · ResponsesError
      • code
        Type: string
        verplicht
      • message
        Type: string
        verplicht
      • propertyName
        Type: anything
    • metadata
      Type: object
      • propertyName
        Type: anything
    • model
      Type: string
    • output
      Type: array object[]
      • propertyName
        Type: anything
    • output_text
      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/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