Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Cipta respons model

Felo API Support
MIT
Pelayan:https://openapi.felo.ai
Pustaka Klien
Shell Curl

Cipta respons model

​

Endpoint serasi API OpenAI Responses. Respons tanpa penstriman yang berjaya menggunakan bentuk objek Responses; apabila stream=true, endpoint memulangkan peristiwa SSE Responses. Objek Responses yang gagal boleh menggunakan status=failed dengan error={code,message} walaupun permintaan HTTP itu sendiri selesai.

Pengepala
  • X-Felo-Channel
    Jenis: string

    Kod saluran awam yang dipisahkan koma dan tersusun. Tinggalkan pengepala ini untuk menggunakan default; default mesti digunakan secara bersendirian. Dalam mod dompet, default mengimbas susunan saluran awam berkesan model secara terbalik, melangkau saluran yang tidak diterbitkan atau tidak tersedia, dan memilih penyedia saluran pertama yang tersedia. Ia merangkumi endpoint tersedia daripada penyedia itu dengan ID model huluan dan tahap perkhidmatan yang sama. Saluran eksplisit disahkan mengikut susunan yang ditetapkan klien; hanya kumpulan penyedia saluran pertama yang dihantar. Tiada sandaran automatik kepada penyedia lain. Pengepala penyedia legasi tidak boleh mengatasi penghalaan saluran.

Badan·ResponsesRequest
wajib
application/json
  • input
    wajib
    • Jenis: string
  • model
    Jenis: string
    wajib
  • include
    Jenis: array string[]
  • instructions
    Jenis: string
  • max_output_tokens
    Jenis: integer
    min:  
    1

    Integer numbers.

  • metadata
    Jenis: object
    • propertyName
      Jenis: anything
  • previous_response_id
    Jenis: string
  • reasoning
    Jenis: object
    • propertyName
      Jenis: anything
  • service_tier
    Jenis: string | null

    Pada masa ini hanya default (standard) disokong. Nilai yang ditinggalkan, null, alias dan rentetan tidak disokong akan kembali kepada default; jenis lain memulangkan HTTP 400. Saluran dan harga yang dikonfigurasikan kekal tidak berubah. API teks menghantar nilai standard penyedia; API Decisions dan penjanaan meninggalkan medan huluan.

  • store
    Jenis: boolean
  • stream
    Jenis: boolean
  • temperature
    Jenis: number
    min:  
    0
  • propertyName
    Jenis: anything
  • text
    Jenis: object
    • propertyName
      Jenis: anything
  • tool_choice
    • Jenis: string
  • tools
    Jenis: array object[]
    • propertyName
      Jenis: anything
  • top_p
    Jenis: number
    min:  
    0
    maks:  
    1
  • propertyName
    Jenis: anything
Respons
  • 200
    Jenis: object · ResponsesResponse

    Objek respons atau peristiwa respons penstriman

    • id
      Jenis: string
      wajib
    • object
      const:  
      response
      wajib
    • status
      Jenis: string enum
      wajib
      nilai
      • completed
      • failed
      • in_progress
      • cancelled
      • queued
      • incomplete
    • error
      Jenis: object · ResponsesError
      • code
        Jenis: string
        wajib
      • message
        Jenis: string
        wajib
      • propertyName
        Jenis: anything
    • metadata
      Jenis: object
      • propertyName
        Jenis: anything
    • model
      Jenis: string
    • output
      Jenis: array object[]
      • propertyName
        Jenis: anything
    • output_text
      Jenis: string
    • usage
      Jenis: object · Usage

      Objek penggunaan penyedia. Medan berbeza mengikut endpoint dan penyedia.

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

    Permintaan, model atau pemetaan penyedia tidak sah

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

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

    Kunci API Felo tidak sah atau tiada

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

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

    Baki tidak mencukupi

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

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

    Akaun tidak dibenarkan menggunakan model ini. Model yang dilumpuhkan juga ditolak sebelum panggilan huluan. Permintaan dan tugas yang telah diterima terus berjalan.

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

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

    Had perbelanjaan atau permintaan telah dicapai

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

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

    Permintaan kepada penyedia huluan gagal

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

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

    Penyedia atau perkhidmatan pengebilan tidak tersedia

    Sampul ralat serasi OpenAI. Router mungkin menyertakan code dan message tanpa semua medan huluan pilihan.

    • error
      Jenis: object
      wajib
      • message
        Jenis: string
        wajib
      • code
        Jenis: string | null
      • param
        Jenis: string | null
      • type
        Jenis: string

        Jenis ralat serasi OpenAI apabila dibekalkan.

      • propertyName
        Jenis: anything
    • propertyName
      Jenis: 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"
}

Objek respons atau peristiwa respons penstriman

Create a model response