Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Submit an image generation task

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клиентские библиотеки
Shell Curl

Submit an image generation task

​

Returns HTTP 202 with a persistent task_id. Poll GET /api/v1/images/generations/{task_id}. Flat input or nested input is supported; nested input takes precedence. Callback fields are ignored. Capabilities and input parameters depend on the configured model and channel.

Заголовки
  • X-Request-Id
    Тип: string

    Optional caller request ID echoed back for diagnostics.

  • X-Felo-Channel
    Тип: string

    Ordered comma-separated public channel codes. Omit this header to use default; default must be used alone. In wallet mode, default scans the model's effective public channel order in reverse, skips unpublished or unavailable channels, and selects the first available channel's provider. It includes available endpoints from that provider with the same upstream model ID and service tier. Explicit channels are validated in client-specified order; only the first channel's provider group is submitted. No automatic fallback to other providers. Legacy provider headers cannot override channel routing.

Тело·ImageGenerationRequest
обязательно
application/json

Model-specific input follows the configured public model protocol.

  • model
    Тип: string
    обязательно
  • image_urls
    Тип: array string[]
  • input
    Тип: object

    Optional nested input; takes precedence over flat input.

    • service_tier
      Тип: string | null

      Currently only default (standard) is supported. Omitted, null, aliases and unsupported strings fallback to default; other types return HTTP 400. Configured channels and prices remain unchanged. Text APIs send the provider's standard value; Decisions and generation APIs omit the upstream field.

    • propertyName
      Тип: anything
  • n
    Тип: integer

    Integer numbers.

  • prompt
    Тип: string
  • service_tier
    Тип: string | null

    Currently only default (standard) is supported. Omitted, null, aliases and unsupported strings fallback to default; other types return HTTP 400. Configured channels and prices remain unchanged. Text APIs send the provider's standard value; Decisions and generation APIs omit the upstream field.

  • size
    Тип: string
  • propertyName
    Тип: anything
Ответы
  • 202
    Тип: object · ImageGenerationAccepted

    Task accepted

    • kind
      enum
      константа:  
      image
      обязательно
      значения
      • image
    • outputs
      Тип: array string[]
      обязательно

      Empty until the task succeeds.

    • status
      enum
      константа:  
      queued
      обязательно
      значения
      • queued
    • task_id
      Тип: string
      обязательно

      Task id to use for polling.

    application/json
  • 400
    Тип: object · GenerationError

    Invalid request (unknown model, mixed input modes, invalid fields)

    OpenAI-compatible error envelope.

    • error
      Тип: object
      • message
        Тип: string
        обязательно
      • type
        Тип: string enum
        обязательно
        значения
        • invalid_request_error
        • server_error
      • code
        Тип: string
      • param
        Тип: string может быть null
    application/json
  • 401
    Тип: object · GenerationError

    Invalid or missing Felo API key

    OpenAI-compatible error envelope.

    • error
      Тип: object
      • message
        Тип: string
        обязательно
      • type
        Тип: string enum
        обязательно
        значения
        • invalid_request_error
        • server_error
      • code
        Тип: string
      • param
        Тип: string может быть null
    application/json
  • 402
    Тип: object · GenerationError

    Insufficient balance / billing requirement not met

    OpenAI-compatible error envelope.

    • error
      Тип: object
      • message
        Тип: string
        обязательно
      • type
        Тип: string enum
        обязательно
        значения
        • invalid_request_error
        • server_error
      • code
        Тип: string
      • param
        Тип: string может быть null
    application/json
  • 403
    Тип: object · GenerationError

    Account not permitted (subscription required or user banned). Disabled models are also rejected before upstream calls. Existing accepted requests and tasks continue.

    OpenAI-compatible error envelope.

    • error
      Тип: object
      • message
        Тип: string
        обязательно
      • type
        Тип: string enum
        обязательно
        значения
        • invalid_request_error
        • server_error
      • code
        Тип: string
      • param
        Тип: string может быть null
    application/json
  • 429
    Тип: object · GenerationError

    Request or spending limit reached

    OpenAI-compatible error envelope.

    • error
      Тип: object
      • message
        Тип: string
        обязательно
      • type
        Тип: string enum
        обязательно
        значения
        • invalid_request_error
        • server_error
      • code
        Тип: string
      • param
        Тип: string может быть null
    application/json
  • 502
    Тип: object · GenerationError

    Upstream provider failed

    OpenAI-compatible error envelope.

    • error
      Тип: object
      • message
        Тип: string
        обязательно
      • type
        Тип: string enum
        обязательно
        значения
        • invalid_request_error
        • server_error
      • code
        Тип: string
      • param
        Тип: string может быть null
    application/json
  • 503
    Тип: object · GenerationError

    Generation service or billing service temporarily unavailable

    OpenAI-compatible error envelope.

    • error
      Тип: object
      • message
        Тип: string
        обязательно
      • type
        Тип: string enum
        обязательно
        значения
        • invalid_request_error
        • server_error
      • code
        Тип: string
      • param
        Тип: string может быть 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"
  ]
}

Task accepted

Submit an image generation task