Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Get an image generation task

Felo API Support
MIT
サーバー:https://openapi.felo.ai
クライアントライブラリ
Shell Curl

Get an image generation task

​

Read the persistent image task for the authenticated caller.

パスパラメーター
  • task_id
    型: string
    必須

    Task id returned by POST /api/v1/videos/generations.

レスポンス
  • 200
    型: object · ImageGenerationTask

    Current task state

    • kind
      列挙値
      定数:  
      image
      必須
      値
      • image
    • outputs
      型: array string[] 形式: uri
      必須
    • status
      型: string 列挙値
      必須
      値
      • queued
      • running
      • succeeded
      • failed
      • interrupted
    • task_id
      型: string
      必須
    • error
      型: object

      Present when the task failed.

      • message
        型: string
      • type
        型: string
    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
  • 404
    型: object · GenerationError

    Task not found for this account

    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 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 get/api/v1/images/generations/{task_id}
curl 'https://openapi.felo.ai/api/v1/images/generations/{task_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "task_id": "string",
  "status": "queued",
  "kind": "image",
  "outputs": [
    "https://example.com"
  ],
  "error": {
    "message": "string",
    "type": "string"
  }
}

Current task state

Get an image generation task