Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Görsel oluşturma görevi gönderin

Felo API Support
MIT
Sunucu:https://openapi.felo.ai
İstemci Kitaplıkları
Shell Curl

Görsel oluşturma görevi gönderin

​

Kalıcı bir task_id ile HTTP 202 döndürür. GET /api/v1/images/generations/{task_id} adresini yoklayın. Düz veya iç içe giriş desteklenir; iç içe giriş öncelik kazanır. Geri çağırma alanları yok sayılır. Yetenekler ve giriş parametreleri yapılandırılmış modele ve kanala bağlıdır.

Başlıklar
  • X-Request-Id
    Tür: string

    Tanılama için geri yansıtılan isteğe bağlı çağıran istek kimliği.

  • X-Felo-Channel
    Tür: string

    Virgülle ayrılmış sıralı genel kanal kodları. Varsayılanı kullanmak için bu başlığı atlayın; default tek başına kullanılmalıdır. Cüzdan modunda default, modelin geçerli genel kanal sırasını tersten tarar, yayımlanmamış veya kullanılamayan kanalları atlar ve ilk kullanılabilir kanalın sağlayıcısını seçer. Aynı üst kaynak model kimliğine ve hizmet katmanına sahip, o sağlayıcıya ait kullanılabilir uç noktaları içerir. Açıkça belirtilen kanallar istemcinin belirttiği sırayla doğrulanır; yalnızca ilk kanalın sağlayıcı grubu gönderilir. Diğer sağlayıcılara otomatik geçiş yapılmaz. Eski sağlayıcı başlıkları kanal yönlendirmesini geçersiz kılamaz.

Gövde·ImageGenerationRequest
gerekli
application/json

Modele özgü girdi, yapılandırılmış genel model protokolünü izler.

  • model
    Tür: string
    gerekli
  • image_urls
    Tür: array string[]
  • input
    Tür: object

    İsteğe bağlı iç içe input; düz girdiye göre öncelik kazanır.

    • service_tier
      Tür: string | null

      Şu anda yalnızca default (standart) desteklenir. Atlanan, null, takma adlar ve desteklenmeyen dizeler default değerine döner; diğer türler HTTP 400 döndürür. Yapılandırılmış kanallar ve fiyatlar değişmez. Metin API'leri sağlayıcının standart değerini gönderir; Decisions ve oluşturma API'leri üst kaynak alanını atlar.

    • propertyName
      Tür: anything
  • n
    Tür: integer

    Integer numbers.

  • prompt
    Tür: string
  • service_tier
    Tür: string | null

    Şu anda yalnızca default (standart) desteklenir. Atlanan, null, takma adlar ve desteklenmeyen dizeler default değerine döner; diğer türler HTTP 400 döndürür. Yapılandırılmış kanallar ve fiyatlar değişmez. Metin API'leri sağlayıcının standart değerini gönderir; Decisions ve oluşturma API'leri üst kaynak alanını atlar.

  • size
    Tür: string
  • propertyName
    Tür: anything
Yanıtlar
  • 202
    Tür: object · ImageGenerationAccepted

    Görev kabul edildi

    • kind
      enum
      sabit:  
      image
      gerekli
      değerler
      • image
    • outputs
      Tür: array string[]
      gerekli

      Görev başarılı olana kadar boş.

    • status
      enum
      sabit:  
      queued
      gerekli
      değerler
      • queued
    • task_id
      Tür: string
      gerekli

      Yoklama için kullanılacak görev kimliği.

    application/json
  • 400
    Tür: object · GenerationError

    Geçersiz istek (bilinmeyen model, karışık giriş modları, geçersiz alanlar)

    OpenAI uyumlu hata zarfı.

    • error
      Tür: object
      • message
        Tür: string
        gerekli
      • type
        Tür: string enum
        gerekli
        değerler
        • invalid_request_error
        • server_error
      • code
        Tür: string
      • param
        Tür: string null olabilir
    application/json
  • 401
    Tür: object · GenerationError

    Geçersiz veya eksik Felo API anahtarı

    OpenAI uyumlu hata zarfı.

    • error
      Tür: object
      • message
        Tür: string
        gerekli
      • type
        Tür: string enum
        gerekli
        değerler
        • invalid_request_error
        • server_error
      • code
        Tür: string
      • param
        Tür: string null olabilir
    application/json
  • 402
    Tür: object · GenerationError

    Yetersiz bakiye / faturalandırma koşulu karşılanmadı

    OpenAI uyumlu hata zarfı.

    • error
      Tür: object
      • message
        Tür: string
        gerekli
      • type
        Tür: string enum
        gerekli
        değerler
        • invalid_request_error
        • server_error
      • code
        Tür: string
      • param
        Tür: string null olabilir
    application/json
  • 403
    Tür: object · GenerationError

    Hesabın izni yok (abonelik gerekli veya kullanıcı yasaklanmış). Devre dışı modeller de üst kaynak çağrılarından önce reddedilir. Mevcut kabul edilmiş istekler ve görevler devam eder.

    OpenAI uyumlu hata zarfı.

    • error
      Tür: object
      • message
        Tür: string
        gerekli
      • type
        Tür: string enum
        gerekli
        değerler
        • invalid_request_error
        • server_error
      • code
        Tür: string
      • param
        Tür: string null olabilir
    application/json
  • 429
    Tür: object · GenerationError

    İstek veya harcama sınırına ulaşıldı

    OpenAI uyumlu hata zarfı.

    • error
      Tür: object
      • message
        Tür: string
        gerekli
      • type
        Tür: string enum
        gerekli
        değerler
        • invalid_request_error
        • server_error
      • code
        Tür: string
      • param
        Tür: string null olabilir
    application/json
  • 502
    Tür: object · GenerationError

    Üst kaynak sağlayıcı başarısız oldu

    OpenAI uyumlu hata zarfı.

    • error
      Tür: object
      • message
        Tür: string
        gerekli
      • type
        Tür: string enum
        gerekli
        değerler
        • invalid_request_error
        • server_error
      • code
        Tür: string
      • param
        Tür: string null olabilir
    application/json
  • 503
    Tür: object · GenerationError

    Oluşturma hizmeti veya faturalandırma hizmeti geçici olarak kullanılamıyor

    OpenAI uyumlu hata zarfı.

    • error
      Tür: object
      • message
        Tür: string
        gerekli
      • type
        Tür: string enum
        gerekli
        değerler
        • invalid_request_error
        • server_error
      • code
        Tür: string
      • param
        Tür: string null olabilir
    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"
  ]
}

Görev kabul edildi

Submit an image generation task