Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Odeslat úlohu generování obrázku

Felo API Support
MIT
Server:https://openapi.felo.ai
Klientské knihovny
Shell Curl

Odeslat úlohu generování obrázku

​

Vrací HTTP 202 s trvalým task_id. Opakovaně dotazujte GET /api/v1/images/generations/{task_id}. Podporován je plochý i vnořený vstup; vnořený vstup má přednost. Pole pro zpětné volání se ignorují. Možnosti a vstupní parametry závisí na nakonfigurovaném modelu a kanálu.

Hlavičky
  • X-Request-Id
    Typ: string

    Volitelné ID požadavku volajícího, které se vrací pro diagnostiku.

  • X-Felo-Channel
    Typ: string

    Seřazené kódy veřejných kanálů oddělené čárkami. Pokud tuto hlavičku vynecháte, použije se default; default lze použít pouze samostatně. V režimu peněženky prochází default efektivní pořadí veřejných kanálů modelu v opačném směru, přeskakuje nepublikované nebo nedostupné kanály a vybere poskytovatele prvního dostupného kanálu. Zahrnuje dostupné endpointy tohoto poskytovatele se stejným ID modelu v upstreamu a stejnou úrovní služby. Explicitní kanály se ověřují v pořadí zadaném klientem; odešle se pouze skupina poskytovatele prvního kanálu. K automatickému přepnutí na jiné poskytovatele nedochází. Starší hlavičky poskytovatele nemohou přepsat směrování kanálů.

Tělo·ImageGenerationRequest
povinné
application/json

Vstup specifický pro model se řídí nakonfigurovaným veřejným protokolem modelu.

  • model
    Typ: string
    povinné
  • image_urls
    Typ: array string[]
  • input
    Typ: object

    Volitelný vnořený vstup; má přednost před plochým vstupem.

    • service_tier
      Typ: string | null

      V současnosti je podporována pouze hodnota default (standard). Vynechaná hodnota, null, aliasy a nepodporované řetězce se převedou na default; jiné typy vrací HTTP 400. Nakonfigurované kanály a ceny zůstávají beze změny. Textová API odesílají standardní hodnotu poskytovatele; rozhraní Decisions a rozhraní generování pole upstreamu vynechávají.

    • propertyName
      Typ: anything
  • n
    Typ: integer

    Integer numbers.

  • prompt
    Typ: string
  • service_tier
    Typ: string | null

    V současnosti je podporována pouze hodnota default (standard). Vynechaná hodnota, null, aliasy a nepodporované řetězce se převedou na default; jiné typy vrací HTTP 400. Nakonfigurované kanály a ceny zůstávají beze změny. Textová API odesílají standardní hodnotu poskytovatele; rozhraní Decisions a rozhraní generování pole upstreamu vynechávají.

  • size
    Typ: string
  • propertyName
    Typ: anything
Odpovědi
  • 202
    Typ: object · ImageGenerationAccepted

    Úloha přijata

    • kind
      enum
      const:  
      image
      povinné
      hodnoty
      • image
    • outputs
      Typ: array string[]
      povinné

      Prázdné, dokud úloha neuspěje.

    • status
      enum
      const:  
      queued
      povinné
      hodnoty
      • queued
    • task_id
      Typ: string
      povinné

      ID úlohy pro dotazování stavu.

    application/json
  • 400
    Typ: object · GenerationError

    Neplatný požadavek (neznámý model, smíšené režimy vstupu, neplatná pole)

    Obálka chyb kompatibilní s OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        povinné
      • type
        Typ: string enum
        povinné
        hodnoty
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string může být null
    application/json
  • 401
    Typ: object · GenerationError

    Neplatný nebo chybějící API klíč Felo

    Obálka chyb kompatibilní s OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        povinné
      • type
        Typ: string enum
        povinné
        hodnoty
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string může být null
    application/json
  • 402
    Typ: object · GenerationError

    Nedostatečný zůstatek / nesplněná podmínka fakturace

    Obálka chyb kompatibilní s OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        povinné
      • type
        Typ: string enum
        povinné
        hodnoty
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string může být null
    application/json
  • 403
    Typ: object · GenerationError

    Účet nemá oprávnění (vyžadováno předplatné nebo je uživatel zablokován). Zakázané modely se odmítají ještě před voláním upstreamu. Již přijaté požadavky a úlohy pokračují.

    Obálka chyb kompatibilní s OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        povinné
      • type
        Typ: string enum
        povinné
        hodnoty
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string může být null
    application/json
  • 429
    Typ: object · GenerationError

    Dosažen limit požadavků nebo utrácení

    Obálka chyb kompatibilní s OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        povinné
      • type
        Typ: string enum
        povinné
        hodnoty
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string může být null
    application/json
  • 502
    Typ: object · GenerationError

    Selhání poskytovatele upstream

    Obálka chyb kompatibilní s OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        povinné
      • type
        Typ: string enum
        povinné
        hodnoty
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string může být null
    application/json
  • 503
    Typ: object · GenerationError

    Služba generování nebo fakturační služba je dočasně nedostupná

    Obálka chyb kompatibilní s OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        povinné
      • type
        Typ: string enum
        povinné
        hodnoty
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string může být 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"
  ]
}

Úloha přijata

Submit an image generation task