Felo API PlatformFelo API Platform
v0.3.0
OpenAPI 3.1.0

Create a model response

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

Create a model response

​

OpenAI Responses API-compatible endpoint. A successful non-streaming response uses the Responses object shape; when stream=true the endpoint returns Responses SSE events. A failed Responses object can use status=failed with error={code,message} even when the HTTP request itself completed.

Body·ResponsesRequest
required
application/json
  • input
    required
    • Type: string
  • model
    Type: string
    required
  • 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
  • store
    Type: boolean
  • stream
    Type: boolean
  • temperature
    Type: number
    min:  
    0
  • text
    Type: object
    • propertyName
      Type: anything
  • 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
Responses
  • 200
    Type: object · ResponsesResponse

    Response object or streaming response events

    • id
      Type: string
      required
    • object
      const:  
      response
      required
    • status
      Type: string enum
      required
      values
      • completed
      • failed
      • in_progress
      • cancelled
      • queued
      • incomplete
    • error
      Type: object · ResponsesError
      • code
        Type: string
        required
      • message
        Type: string
        required
      • 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

      Provider usage object. Fields vary by endpoint and provider.

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

    Invalid request, model, or provider mapping

    OpenAI-compatible error envelope. The Router may include code and message without all optional upstream fields.

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

        OpenAI-compatible error type when supplied.

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

    Invalid or missing Felo API key

    OpenAI-compatible error envelope. The Router may include code and message without all optional upstream fields.

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

        OpenAI-compatible error type when supplied.

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

    Insufficient balance

    OpenAI-compatible error envelope. The Router may include code and message without all optional upstream fields.

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

        OpenAI-compatible error type when supplied.

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

    Account is not permitted to use the model. Disabled models are also rejected before upstream calls. Existing accepted requests and tasks continue.

    OpenAI-compatible error envelope. The Router may include code and message without all optional upstream fields.

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

        OpenAI-compatible error type when supplied.

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

    Spending or request limit reached

    OpenAI-compatible error envelope. The Router may include code and message without all optional upstream fields.

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

        OpenAI-compatible error type when supplied.

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

    Upstream provider request failed

    OpenAI-compatible error envelope. The Router may include code and message without all optional upstream fields.

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

        OpenAI-compatible error type when supplied.

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

    Provider or billing service unavailable

    OpenAI-compatible error envelope. The Router may include code and message without all optional upstream fields.

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

        OpenAI-compatible error type when supplied.

      • 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"
}

Response object or streaming response events

Create a model response