Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Создание ответа модели

Сервер:https://openapi.felo.ai
Клиентские библиотеки

Создание ответа модели

​

Эндпоинт, совместимый с OpenAI Responses API. Успешный непотоковый ответ имеет форму объекта Responses; при stream=true эндпоинт возвращает SSE-события Responses. Объект Responses с ошибкой может использовать status=failed и error={code,message}, даже если сам HTTP-запрос завершился успешно.

Заголовки
  • X-Felo-Channel
    Тип: string

    Упорядоченные публичные коды каналов через запятую. Опустите этот заголовок, чтобы использовать значение по умолчанию; default должен использоваться только сам по себе. В режиме wallet значение по умолчанию просматривает эффективный публичный порядок каналов модели в обратном направлении, пропускает неопубликованные и недоступные каналы и выбирает провайдера первого доступного канала. Оно включает доступные эндпоинты этого провайдера с тем же upstream ID модели и уровнем обслуживания. Явные каналы проверяются в порядке, указанном клиентом; отправляется только группа провайдера первого канала. Автоматического переключения на других провайдеров нет. Устаревшие заголовки провайдеров не могут переопределить маршрутизацию по каналам.

Тело·ResponsesRequest
обязательно
application/json
  • input
    обязательно

    Reference a Felo PDF with input_file.file_id or an uploaded image with input_image.file_id in a message content array. The model must be enabled for the attachment type. The combined limit for Felo file references is 50 MB per request. PDF file_url/file_data and image_url (HTTPS or a data URL) use the native format.

    • Тип: string

      Reference a Felo PDF with input_file.file_id or an uploaded image with input_image.file_id in a message content array. The model must be enabled for the attachment type. The combined limit for Felo file references is 50 MB per request. PDF file_url/file_data and image_url (HTTPS or a data URL) use the native format.

  • model
    Тип: string
    обязательно
  • include
    Тип: array string[]
  • instructions
    Тип: string
  • max_output_tokens
    Тип: integer
    мин.:  
    1

    Integer numbers.

  • metadata
    Тип: object
    • propertyName
      Тип: anything
  • previous_response_id
    Тип: string
  • reasoning
    Тип: object
    • propertyName
      Тип: anything
  • service_tier
    Тип: string | null

    Сейчас поддерживается только default (стандартный). Если поле опущено, равно null, содержит псевдоним или неподдерживаемую строку, используется значение по умолчанию; другие типы возвращают HTTP 400. Настроенные каналы и цены не меняются. Текстовые API передают стандартное значение провайдера; Decisions и API генерации опускают поле upstream.

  • store
    Тип: boolean
  • stream
    Тип: boolean
  • temperature
    Тип: number
    мин.:  
    0
  • propertyName
    Тип: anything
  • text
    Тип: object
    • propertyName
      Тип: anything
  • tool_choice
    • Тип: string
  • tools
    Тип: array object[]
    • propertyName
      Тип: anything
  • top_p
    Тип: number
    мин.:  
    0
    макс.:  
    1
  • propertyName
    Тип: anything
Ответы
  • 200
    Тип: object · ResponsesResponse

    Объект ответа или события потокового ответа

    • id
      Тип: string
      обязательно
    • object
      константа:  
      response
      обязательно
    • status
      Тип: string enum
      обязательно
      значения
      • completed
      • failed
      • in_progress
      • cancelled
      • queued
      • incomplete
    • error
      Тип: object · ResponsesError
      • code
        Тип: string
        обязательно
      • message
        Тип: string
        обязательно
      • propertyName
        Тип: anything
    • metadata
      Тип: object
      • propertyName
        Тип: anything
    • model
      Тип: string
    • output
      Тип: array object[]
      • propertyName
        Тип: anything
    • output_text
      Тип: string
    • usage
      Тип: object · Usage

      Объект использования провайдера. Поля зависят от эндпоинта и провайдера.

      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
  • 400
    Тип: object · OpenAIErrorResponse

    Некорректный запрос, модель или сопоставление провайдера

    Конверт ошибок, совместимый с OpenAI. Router может включать code и message без всех необязательных полей upstream.

    • error
      Тип: object
      обязательно
      • message
        Тип: string
        обязательно
      • code
        Тип: string | null
      • param
        Тип: string | null
      • type
        Тип: string

        Тип ошибки, совместимый с OpenAI, если он передан.

      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
    application/json
  • 401
    Тип: object · OpenAIErrorResponse

    Недействительный или отсутствующий API-ключ Felo

    Конверт ошибок, совместимый с OpenAI. Router может включать code и message без всех необязательных полей upstream.

    • error
      Тип: object
      обязательно
      • message
        Тип: string
        обязательно
      • code
        Тип: string | null
      • param
        Тип: string | null
      • type
        Тип: string

        Тип ошибки, совместимый с OpenAI, если он передан.

      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
    application/json
  • 402
    Тип: object · OpenAIErrorResponse

    Недостаточно средств на балансе

    Конверт ошибок, совместимый с OpenAI. Router может включать code и message без всех необязательных полей upstream.

    • error
      Тип: object
      обязательно
      • message
        Тип: string
        обязательно
      • code
        Тип: string | null
      • param
        Тип: string | null
      • type
        Тип: string

        Тип ошибки, совместимый с OpenAI, если он передан.

      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
    application/json
  • 403
    Тип: object · OpenAIErrorResponse

    Аккаунт не имеет права использовать модель. Отключённые модели также отклоняются до вызова upstream. Уже принятые запросы и задачи продолжают выполняться.

    Конверт ошибок, совместимый с OpenAI. Router может включать code и message без всех необязательных полей upstream.

    • error
      Тип: object
      обязательно
      • message
        Тип: string
        обязательно
      • code
        Тип: string | null
      • param
        Тип: string | null
      • type
        Тип: string

        Тип ошибки, совместимый с OpenAI, если он передан.

      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
    application/json
  • 429
    Тип: object · OpenAIErrorResponse

    Достигнут лимит расходов или запросов

    Конверт ошибок, совместимый с OpenAI. Router может включать code и message без всех необязательных полей upstream.

    • error
      Тип: object
      обязательно
      • message
        Тип: string
        обязательно
      • code
        Тип: string | null
      • param
        Тип: string | null
      • type
        Тип: string

        Тип ошибки, совместимый с OpenAI, если он передан.

      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
    application/json
  • 502
    Тип: object · OpenAIErrorResponse

    Сбой запроса к upstream-провайдеру

    Конверт ошибок, совместимый с OpenAI. Router может включать code и message без всех необязательных полей upstream.

    • error
      Тип: object
      обязательно
      • message
        Тип: string
        обязательно
      • code
        Тип: string | null
      • param
        Тип: string | null
      • type
        Тип: string

        Тип ошибки, совместимый с OpenAI, если он передан.

      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
    application/json
  • 503
    Тип: object · OpenAIErrorResponse

    Провайдер или сервис биллинга недоступен

    Конверт ошибок, совместимый с OpenAI. Router может включать code и message без всех необязательных полей upstream.

    • error
      Тип: object
      обязательно
      • message
        Тип: string
        обязательно
      • code
        Тип: string | null
      • param
        Тип: string | null
      • type
        Тип: string

        Тип ошибки, совместимый с OpenAI, если он передан.

      • propertyName
        Тип: anything
    • propertyName
      Тип: 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

Нужна помощь?