Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Prześlij zadanie generowania obrazu

Felo API Support
MIT
Serwer:https://openapi.felo.ai
Biblioteki klienckie
Shell Curl

Prześlij zadanie generowania obrazu

​

Zwraca HTTP 202 z trwałym task_id. Odpytuj GET /api/v1/images/generations/{task_id}. Obsługiwane jest wejście płaskie lub zagnieżdżone; wejście zagnieżdżone ma pierwszeństwo. Pola callback są ignorowane. Możliwości i parametry wejściowe zależą od skonfigurowanego modelu i kanału.

Nagłówki
  • X-Request-Id
    Typ: string

    Opcjonalny identyfikator żądania wywołującego, zwracany w celach diagnostycznych.

  • X-Felo-Channel
    Typ: string

    Uporządkowane kody publicznych kanałów rozdzielone przecinkami. Pomiń ten nagłówek, aby użyć wartości domyślnej; wartość domyślna musi być używana samodzielnie. W trybie portfela wartość domyślna przegląda efektywną kolejność publicznych kanałów modelu od końca, pomija kanały nieopublikowane lub niedostępne i wybiera dostawcę pierwszego dostępnego kanału. Obejmuje dostępne endpointy tego dostawcy o tym samym identyfikatorze modelu upstream i tym samym poziomie usługi. Jawne kanały są weryfikowane w kolejności podanej przez klienta; przesyłana jest tylko grupa dostawcy pierwszego kanału. Brak automatycznego przełączania na innych dostawców. Przestarzałe nagłówki dostawcy nie mogą nadpisać routingu kanałów.

Treść·ImageGenerationRequest
wymagane
application/json

Wejście zależne od modelu jest zgodne ze skonfigurowanym publicznym protokołem modelu.

  • model
    Typ: string
    wymagane
  • image_urls
    Typ: array string[]
  • input
    Typ: object

    Opcjonalne zagnieżdżone wejście; ma pierwszeństwo przed wejściem płaskim.

    • service_tier
      Typ: string | null

      Obecnie obsługiwana jest tylko wartość default (standard). Pominięcie, null, aliasy i nieobsługiwane ciągi znaków powodują powrót do wartości default; inne typy zwracają HTTP 400. Skonfigurowane kanały i ceny pozostają bez zmian. Interfejsy API modeli tekstowych wysyłają standardową wartość dostawcy; interfejsy Decisions i generowania pomijają pole upstream.

    • propertyName
      Typ: anything
  • n
    Typ: integer

    Integer numbers.

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

    Obecnie obsługiwana jest tylko wartość default (standard). Pominięcie, null, aliasy i nieobsługiwane ciągi znaków powodują powrót do wartości default; inne typy zwracają HTTP 400. Skonfigurowane kanały i ceny pozostają bez zmian. Interfejsy API modeli tekstowych wysyłają standardową wartość dostawcy; interfejsy Decisions i generowania pomijają pole upstream.

  • size
    Typ: string
  • propertyName
    Typ: anything
Odpowiedzi
  • 202
    Typ: object · ImageGenerationAccepted

    Zadanie przyjęte

    • kind
      enum
      const:  
      image
      wymagane
      wartości
      • image
    • outputs
      Typ: array string[]
      wymagane

      Puste, dopóki zadanie się nie powiedzie.

    • status
      enum
      const:  
      queued
      wymagane
      wartości
      • queued
    • task_id
      Typ: string
      wymagane

      Identyfikator zadania używany do odpytywania.

    application/json
  • 400
    Typ: object · GenerationError

    Nieprawidłowe żądanie (nieznany model, mieszane tryby wejścia, nieprawidłowe pola)

    Koperta błędu zgodna z OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        wymagane
      • type
        Typ: string enum
        wymagane
        wartości
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string dopuszcza null
    application/json
  • 401
    Typ: object · GenerationError

    Nieprawidłowy lub brakujący klucz API Felo

    Koperta błędu zgodna z OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        wymagane
      • type
        Typ: string enum
        wymagane
        wartości
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string dopuszcza null
    application/json
  • 402
    Typ: object · GenerationError

    Niewystarczające saldo / niespełniony warunek rozliczeniowy

    Koperta błędu zgodna z OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        wymagane
      • type
        Typ: string enum
        wymagane
        wartości
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string dopuszcza null
    application/json
  • 403
    Typ: object · GenerationError

    Konto nie ma uprawnień (wymagana subskrypcja lub użytkownik zablokowany). Wyłączone modele są również odrzucane przed wywołaniami upstream. Istniejące przyjęte żądania i zadania są kontynuowane.

    Koperta błędu zgodna z OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        wymagane
      • type
        Typ: string enum
        wymagane
        wartości
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string dopuszcza null
    application/json
  • 429
    Typ: object · GenerationError

    Osiągnięto limit żądań lub wydatków

    Koperta błędu zgodna z OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        wymagane
      • type
        Typ: string enum
        wymagane
        wartości
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string dopuszcza null
    application/json
  • 502
    Typ: object · GenerationError

    Błąd dostawcy upstream

    Koperta błędu zgodna z OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        wymagane
      • type
        Typ: string enum
        wymagane
        wartości
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string dopuszcza null
    application/json
  • 503
    Typ: object · GenerationError

    Usługa generowania lub usługa rozliczeniowa tymczasowo niedostępna

    Koperta błędu zgodna z OpenAI.

    • error
      Typ: object
      • message
        Typ: string
        wymagane
      • type
        Typ: string enum
        wymagane
        wartości
        • invalid_request_error
        • server_error
      • code
        Typ: string
      • param
        Typ: string dopuszcza 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"
  ]
}

Zadanie przyjęte

Submit an image generation task