Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

モデルレスポンスを作成

サーバー:https://openapi.felo.ai
クライアントライブラリ

モデルレスポンスを作成

​

OpenAI Responses API 互換のエンドポイントです。非ストリーミングで成功したレスポンスは Responses オブジェクトの形式を使用します。stream=true の場合、エンドポイントは Responses の SSE イベントを返します。失敗した Responses オブジェクトは、HTTP リクエスト自体が完了した場合でも status=failed と error={code,message} を使用できます。

ヘッダー
  • X-Felo-Channel
    型: string

    カンマ区切りの公開チャンネルコード(順序どおり)。このヘッダーを省略すると default が使われ、default は単独でのみ使用できます。ウォレットモードでは、default はモデルの有効な公開チャンネル順を逆から走査し、未公開または利用不可のチャンネルをスキップして、最初に利用可能なチャンネルのプロバイダーを選択します。そのプロバイダーから、同じ上流モデル 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(standard)のみをサポートしています。省略、null、エイリアス、未対応の文字列は default にフォールバックし、それ以外のタイプは HTTP 400 を返します。設定済みのチャンネルと料金は変わりません。テキスト API はプロバイダーの標準値を使用し、Decisions と生成 API は上流のフィールドを省略します。

  • 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 列挙値
      必須
      値
      • 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

      プロバイダーの usage オブジェクト。フィールドはエンドポイントとプロバイダーによって異なります。

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

    無効なリクエスト、モデル、またはプロバイダーマッピング

    OpenAI 互換のエラーエンベロープ。Router は、上流の任意フィールドをすべて含めずに code と message を返す場合があります。

    • error
      型: object
      必須
      • message
        型: string
        必須
      • code
        型: string | null
      • param
        型: string | null
      • type
        型: string

        指定された場合の OpenAI 互換のエラータイプ。

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

    Felo APIキーが無効または未指定です

    OpenAI 互換のエラーエンベロープ。Router は、上流の任意フィールドをすべて含めずに code と message を返す場合があります。

    • 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 を返す場合があります。

    • error
      型: object
      必須
      • message
        型: string
        必須
      • code
        型: string | null
      • param
        型: string | null
      • type
        型: string

        指定された場合の OpenAI 互換のエラータイプ。

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

    アカウントにこのモデルの使用権限がありません。無効化されたモデルも上流呼び出しの前に拒否されます。既に受け付けたリクエストとタスクは継続します。

    OpenAI 互換のエラーエンベロープ。Router は、上流の任意フィールドをすべて含めずに code と message を返す場合があります。

    • 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 を返す場合があります。

    • error
      型: object
      必須
      • message
        型: string
        必須
      • code
        型: string | null
      • param
        型: string | null
      • type
        型: string

        指定された場合の OpenAI 互換のエラータイプ。

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

    上流プロバイダーへのリクエストに失敗しました

    OpenAI 互換のエラーエンベロープ。Router は、上流の任意フィールドをすべて含めずに code と message を返す場合があります。

    • 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 を返す場合があります。

    • 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

ヘルプが必要ですか?

  • API・請求・アカウントのご質問はサポートへ。
  • Discord で Felo の開発者と交流できます。
  • 更新履歴 をご覧ください。
  • ボリューム価格や購買についてのご相談は営業窓口へ。
  • LLM での構築をお考えですか?llms.txt をご覧ください。