Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Hantar tugas penjanaan imej

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

Hantar tugas penjanaan imej

​

Memulangkan HTTP 202 dengan task_id yang berterusan. Semak GET /api/v1/images/generations/{task_id} secara berkala. Input rata atau input bersarang disokong; input bersarang diutamakan. Medan callback diabaikan. Keupayaan dan parameter input bergantung pada model dan saluran yang dikonfigurasikan.

Pengepala
  • X-Request-Id
    Jenis: string

    ID permintaan pemanggil pilihan yang dipantulkan semula untuk diagnostik.

  • 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·ImageGenerationRequest
wajib
application/json

Input khusus model mengikut protokol model awam yang dikonfigurasikan.

  • model
    Jenis: string
    wajib
  • image_urls
    Jenis: array string[]
  • input
    Jenis: object

    Input bersarang pilihan; diutamakan berbanding input rata.

    • 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.

    • propertyName
      Jenis: anything
  • n
    Jenis: integer

    Integer numbers.

  • prompt
    Jenis: string
  • 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.

  • size
    Jenis: string
  • propertyName
    Jenis: anything
Respons
  • 202
    Jenis: object · ImageGenerationAccepted

    Tugas diterima

    • kind
      enum
      const:  
      image
      wajib
      nilai
      • image
    • outputs
      Jenis: array string[]
      wajib

      Kosong sehingga tugas berjaya.

    • status
      enum
      const:  
      queued
      wajib
      nilai
      • queued
    • task_id
      Jenis: string
      wajib

      ID tugas untuk digunakan semasa menyemak status.

    application/json
  • 400
    Jenis: object · GenerationError

    Permintaan tidak sah (model tidak diketahui, mod input bercampur, medan tidak sah)

    Sampul ralat serasi OpenAI.

    • error
      Jenis: object
      • message
        Jenis: string
        wajib
      • type
        Jenis: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Jenis: string
      • param
        Jenis: string boleh null
    application/json
  • 401
    Jenis: object · GenerationError

    Kunci API Felo tidak sah atau tiada

    Sampul ralat serasi OpenAI.

    • error
      Jenis: object
      • message
        Jenis: string
        wajib
      • type
        Jenis: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Jenis: string
      • param
        Jenis: string boleh null
    application/json
  • 402
    Jenis: object · GenerationError

    Baki tidak mencukupi / keperluan pengebilan tidak dipenuhi

    Sampul ralat serasi OpenAI.

    • error
      Jenis: object
      • message
        Jenis: string
        wajib
      • type
        Jenis: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Jenis: string
      • param
        Jenis: string boleh null
    application/json
  • 403
    Jenis: object · GenerationError

    Akaun tidak dibenarkan (langganan diperlukan atau pengguna disekat). Model yang dilumpuhkan juga ditolak sebelum panggilan huluan. Permintaan dan tugas yang telah diterima terus berjalan.

    Sampul ralat serasi OpenAI.

    • error
      Jenis: object
      • message
        Jenis: string
        wajib
      • type
        Jenis: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Jenis: string
      • param
        Jenis: string boleh null
    application/json
  • 429
    Jenis: object · GenerationError

    Had permintaan atau perbelanjaan telah dicapai

    Sampul ralat serasi OpenAI.

    • error
      Jenis: object
      • message
        Jenis: string
        wajib
      • type
        Jenis: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Jenis: string
      • param
        Jenis: string boleh null
    application/json
  • 502
    Jenis: object · GenerationError

    Penyedia huluan gagal

    Sampul ralat serasi OpenAI.

    • error
      Jenis: object
      • message
        Jenis: string
        wajib
      • type
        Jenis: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Jenis: string
      • param
        Jenis: string boleh null
    application/json
  • 503
    Jenis: object · GenerationError

    Perkhidmatan penjanaan atau perkhidmatan pengebilan tidak tersedia buat sementara waktu

    Sampul ralat serasi OpenAI.

    • error
      Jenis: object
      • message
        Jenis: string
        wajib
      • type
        Jenis: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Jenis: string
      • param
        Jenis: string boleh null
    application/json
Request Example for post/api/v1/images/generations
curl https://openapi.felo.ai/api/v1/images/generations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "configured-image-model",
  "prompt": "a cat"
}'

{
  "task_id": "string",
  "status": "queued",
  "kind": "image",
  "outputs": [
    "string"
  ]
}

Tugas diterima

Submit an image generation task