Skip to main content
GET
Query image generation task

Overview

When you submit an image generation task (text-to-image or image-to-image) you receive a task_id. Use this endpoint to poll the execution lifecycle until the task either completes successfully or fails.
Query every 3–5 seconds to maintain responsiveness without exceeding rate limits.

Endpoint

  • GET https://api.siray.ai/v1/images/generations/async/{task_id}
Headers
  • Authorization: Bearer <SIRAY_API_TOKEN>
Path parameters

Response structure

Fields

  • code / message: Service-level indicators for the request outcome.
  • data.task_id: Echoes the submitted task identifier.
  • data.status: Current lifecycle state — see the table below.
  • data.progress: Human-readable percentage for UI display.
  • data.outputs: Array of public URLs that host the generated image assets (present when status is SUCCESS).
  • data.fail_reason: Populated if generation fails.
  • data.submit_time, data.start_time, data.finish_time: Unix timestamps for auditing latency.

Status values

Usage example

Once status becomes SUCCESS, fetch the image(s) via the URLs in outputs. If the task fails, retry only after resolving the reported fail_reason.

Authorizations

Authorization
string
header
required

Bearer authentication using API key

Path Parameters

task_id
string
required

Identifier returned from the image generation task submission

Response

200 - application/json

Task status and (if available) generated outputs

Async task status query response

code
string
required

Status code returned by the service

Example:

"success"

message
string
required

Additional information about the request result

Example:

""

data
object
required

Task execution details