Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Kirim tugas pembuatan gambar

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

Kirim tugas pembuatan gambar

​

Mengembalikan HTTP 202 dengan task_id persisten. Lakukan polling GET /api/v1/images/generations/{task_id}. Input datar atau input bertingkat didukung; input bertingkat diutamakan. Field callback diabaikan. Kemampuan dan parameter input bergantung pada model dan kanal yang dikonfigurasi.

Header
  • X-Request-Id
    Tipe: string

    ID permintaan pemanggil opsional yang dikembalikan untuk diagnostik.

  • X-Felo-Channel
    Tipe: string

    Kode kanal publik yang dipisahkan koma dan berurutan. Hilangkan header ini untuk menggunakan default; default harus digunakan sendiri. Dalam mode wallet, default memindai urutan kanal publik efektif model secara terbalik, melewati kanal yang tidak dipublikasikan atau tidak tersedia, dan memilih penyedia kanal pertama yang tersedia. Ini mencakup endpoint yang tersedia dari penyedia tersebut dengan ID model upstream dan tingkat layanan yang sama. Kanal eksplisit divalidasi dalam urutan yang ditentukan klien; hanya grup penyedia kanal pertama yang dikirimkan. Tidak ada fallback otomatis ke penyedia lain. Header penyedia lama tidak dapat menimpa perutean kanal.

Isi·ImageGenerationRequest
wajib
application/json

Input khusus model mengikuti protokol model publik yang dikonfigurasi.

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

    Input bertingkat opsional; diutamakan di atas input datar.

    • service_tier
      Tipe: string | null

      Saat ini hanya default (standard) yang didukung. Nilai yang dihilangkan, null, alias, dan string yang tidak didukung akan kembali ke default; tipe lain mengembalikan HTTP 400. Kanal dan harga yang dikonfigurasi tetap tidak berubah. API teks mengirim nilai standar penyedia; API Decisions dan pembuatan menghilangkan field upstream.

    • propertyName
      Tipe: anything
  • n
    Tipe: integer

    Integer numbers.

  • prompt
    Tipe: string
  • service_tier
    Tipe: string | null

    Saat ini hanya default (standard) yang didukung. Nilai yang dihilangkan, null, alias, dan string yang tidak didukung akan kembali ke default; tipe lain mengembalikan HTTP 400. Kanal dan harga yang dikonfigurasi tetap tidak berubah. API teks mengirim nilai standar penyedia; API Decisions dan pembuatan menghilangkan field upstream.

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

    Tugas diterima

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

      Kosong hingga tugas berhasil.

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

      ID tugas yang digunakan untuk polling.

    application/json
  • 400
    Tipe: object · GenerationError

    Permintaan tidak valid (model tidak dikenal, mode input tercampur, field tidak valid)

    Envelope error yang kompatibel dengan OpenAI.

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

    Kunci API Felo tidak valid atau tidak ada

    Envelope error yang kompatibel dengan OpenAI.

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

    Saldo tidak cukup / persyaratan tagihan tidak terpenuhi

    Envelope error yang kompatibel dengan OpenAI.

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

    Akun tidak diizinkan (diperlukan langganan atau pengguna diblokir). Model yang dinonaktifkan juga ditolak sebelum panggilan upstream. Permintaan dan tugas yang sudah diterima tetap berlanjut.

    Envelope error yang kompatibel dengan OpenAI.

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

    Batas permintaan atau pengeluaran tercapai

    Envelope error yang kompatibel dengan OpenAI.

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

    Penyedia upstream gagal

    Envelope error yang kompatibel dengan OpenAI.

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

    Layanan pembuatan atau layanan tagihan sementara tidak tersedia

    Envelope error yang kompatibel dengan OpenAI.

    • error
      Tipe: object
      • message
        Tipe: string
        wajib
      • type
        Tipe: string enum
        wajib
        nilai
        • invalid_request_error
        • server_error
      • code
        Tipe: string
      • param
        Tipe: 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