Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Een afbeeldingsgeneratietaak indienen

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

Een afbeeldingsgeneratietaak indienen

​

Retourneert HTTP 202 met een persistente task_id. Poll GET /api/v1/images/generations/{task_id}. Platte of geneste invoer wordt ondersteund; geneste invoer heeft voorrang. Callbackvelden worden genegeerd. Mogelijkheden en invoerparameters zijn afhankelijk van het geconfigureerde model en kanaal.

Headers
  • X-Request-Id
    Type: string

    Optionele verzoek-ID van de aanroeper die voor diagnostiek wordt teruggegeven.

  • X-Felo-Channel
    Type: string

    Geordende, door komma's gescheiden openbare kanaalcodes. Laat deze header weg om default te gebruiken; default moet alleen worden gebruikt. In walletmodus scant default de effectieve openbare kanaalvolgorde van het model in omgekeerde volgorde, slaat niet-gepubliceerde of niet-beschikbare kanalen over en kiest de aanbieder van het eerste beschikbare kanaal. Het omvat beschikbare endpoints van die aanbieder met hetzelfde upstream-model-ID en hetzelfde serviceniveau. Expliciete kanalen worden gevalideerd in de door de client opgegeven volgorde; alleen de aanbiedergroep van het eerste kanaal wordt ingediend. Geen automatische fallback naar andere aanbieders. Verouderde providerheaders kunnen de kanaalroutering niet overschrijven.

Body·ImageGenerationRequest
verplicht
application/json

Modelspecifieke invoer volgt het geconfigureerde openbare modelprotocol.

  • model
    Type: string
    verplicht
  • image_urls
    Type: array string[]
  • input
    Type: object

    Optionele geneste invoer; heeft voorrang op platte invoer.

    • service_tier
      Type: string | null

      Momenteel wordt alleen default (standaard) ondersteund. Weggelaten, null, aliassen en niet-ondersteunde tekenreeksen vallen terug op default; andere typen retourneren HTTP 400. Geconfigureerde kanalen en prijzen blijven ongewijzigd. Tekst-API's sturen de standaardwaarde van de aanbieder; Decisions- en generatie-API's laten het upstream-veld weg.

    • propertyName
      Type: anything
  • n
    Type: integer

    Integer numbers.

  • prompt
    Type: string
  • service_tier
    Type: string | null

    Momenteel wordt alleen default (standaard) ondersteund. Weggelaten, null, aliassen en niet-ondersteunde tekenreeksen vallen terug op default; andere typen retourneren HTTP 400. Geconfigureerde kanalen en prijzen blijven ongewijzigd. Tekst-API's sturen de standaardwaarde van de aanbieder; Decisions- en generatie-API's laten het upstream-veld weg.

  • size
    Type: string
  • propertyName
    Type: anything
Responsen
  • 202
    Type: object · ImageGenerationAccepted

    Taak geaccepteerd

    • kind
      enum
      constante:  
      image
      verplicht
      waarden
      • image
    • outputs
      Type: array string[]
      verplicht

      Leeg totdat de taak slaagt.

    • status
      enum
      constante:  
      queued
      verplicht
      waarden
      • queued
    • task_id
      Type: string
      verplicht

      Taak-ID om te gebruiken voor polling.

    application/json
  • 400
    Type: object · GenerationError

    Ongeldig verzoek (onbekend model, gemengde invoermodi, ongeldige velden)

    OpenAI-compatibele foutenvelop.

    • error
      Type: object
      • message
        Type: string
        verplicht
      • type
        Type: string enum
        verplicht
        waarden
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string null toegestaan
    application/json
  • 401
    Type: object · GenerationError

    Ongeldige of ontbrekende Felo API-sleutel

    OpenAI-compatibele foutenvelop.

    • error
      Type: object
      • message
        Type: string
        verplicht
      • type
        Type: string enum
        verplicht
        waarden
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string null toegestaan
    application/json
  • 402
    Type: object · GenerationError

    Onvoldoende saldo / factureringsvoorwaarde niet voldaan

    OpenAI-compatibele foutenvelop.

    • error
      Type: object
      • message
        Type: string
        verplicht
      • type
        Type: string enum
        verplicht
        waarden
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string null toegestaan
    application/json
  • 403
    Type: object · GenerationError

    Account heeft geen toestemming (abonnement vereist of gebruiker geblokkeerd). Uitgeschakelde modellen worden ook vóór upstream-aanroepen geweigerd. Bestaande geaccepteerde verzoeken en taken lopen door.

    OpenAI-compatibele foutenvelop.

    • error
      Type: object
      • message
        Type: string
        verplicht
      • type
        Type: string enum
        verplicht
        waarden
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string null toegestaan
    application/json
  • 429
    Type: object · GenerationError

    Limiet voor verzoeken of bestedingen bereikt

    OpenAI-compatibele foutenvelop.

    • error
      Type: object
      • message
        Type: string
        verplicht
      • type
        Type: string enum
        verplicht
        waarden
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string null toegestaan
    application/json
  • 502
    Type: object · GenerationError

    Upstream-aanbieder is mislukt

    OpenAI-compatibele foutenvelop.

    • error
      Type: object
      • message
        Type: string
        verplicht
      • type
        Type: string enum
        verplicht
        waarden
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string null toegestaan
    application/json
  • 503
    Type: object · GenerationError

    Generatiedienst of factureringsdienst tijdelijk niet beschikbaar

    OpenAI-compatibele foutenvelop.

    • error
      Type: object
      • message
        Type: string
        verplicht
      • type
        Type: string enum
        verplicht
        waarden
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string null toegestaan
    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"
  ]
}

Taak geaccepteerd

Submit an image generation task