Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Создание чат-завершения

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

Создание чат-завершения

​

OpenAI-совместимый API Chat Completions. Установите stream=true, чтобы получать Server-Sent Events. Формат ответа и конверт ошибок соответствуют Chat Completions/OpenAI-совместимому формату.

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

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

Тело·ChatCompletionRequest
обязательно
application/json
  • messages
    Тип: array object[] · ChatMessage[] 1…
    обязательно
    • content
      может быть null
      обязательно
      • Тип: string
    • role
      Тип: string enum
      обязательно
      значения
      • system
      • developer
      • user
      • assistant
      • tool
    • name
      Тип: string
    • tool_call_id
      Тип: string
    • tool_calls
      Тип: array object[]
      • propertyName
        Тип: anything
    • propertyName
      Тип: anything
  • model
    Тип: string
    обязательно
  • max_completion_tokens
    Тип: integer
    мин.:  
    1

    Integer numbers.

  • max_tokens
    Тип: integer
    мин.:  
    1

    Integer numbers.

  • n
    Тип: integer
    мин.:  
    1

    Integer numbers.

  • response_format
    Тип: object
    • propertyName
      Тип: anything
  • service_tier
    Тип: string | null

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

  • stop
    может быть null
    • Тип: string
  • stream
    Тип: boolean
  • temperature
    Тип: number
    мин.:  
    0
  • tool_choice
    • Тип: string
  • tools
    Тип: array object[]
    • propertyName
      Тип: anything
  • propertyName
    Тип: anything
  • top_p
    Тип: number
    мин.:  
    0
    макс.:  
    1
  • user
    Тип: string
  • propertyName
    Тип: anything
Ответы
  • 200
    Тип: object · ChatCompletionResponse

    Чат-завершение или потоковый ответ

    • choices
      Тип: array object[] · ChatChoice[]
      обязательно
      • finish_reason
        Тип: string | null
      • index
        Тип: integer

        Integer numbers.

      • logprobs
        Тип: object | null
        • propertyName
          Тип: anything
      • message
        Тип: object · ChatMessage
        • content
          может быть null
          обязательно
          • Тип: string
        • role
          Тип: string enum
          обязательно
          значения
          • system
          • developer
          • user
          • assistant
          • tool
        • name
          Тип: string
        • tool_call_id
          Тип: string
        • tool_calls
          Тип: array object[]
          • propertyName
            Тип: anything
        • propertyName
          Тип: anything
      • propertyName
        Тип: anything
    • id
      Тип: string
      обязательно
    • object
      Тип: string
      обязательно

      Обычно chat.completion для непотоковых ответов.

    • created
      Тип: integer Формат: int64

      Signed 64-bit integers (long type).

    • model
      Тип: string
    • system_fingerprint
      Тип: 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/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

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