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
      열거형
      상수:  
      image
      필수
      값
      • image
    • outputs
      유형: array string[]
      필수

      Empty until the task succeeds.

    • status
      열거형
      상수:  
      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 열거형
        필수
        값
        • 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 열거형
        필수
        값
        • 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 열거형
        필수
        값
        • 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 열거형
        필수
        값
        • 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 열거형
        필수
        값
        • 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 열거형
        필수
        값
        • 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 열거형
        필수
        값
        • 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