Image Generation

Get image result

Returns the status and progress of an image generation or edit job. While the job runs, status is queued or in_progress with a progress percentage. Once status is completed, the result object contains the generated images. Poll this endpoint after submitting a request to Generate image from text or Generate image from image.

get/images/tasks/{job_id}

Request

  • Base URL: https://console.hyperstack.cloud/ai/api/v1
  • URL: https://console.hyperstack.cloud/ai/api/v1/images/tasks/{job_id}
  • Auth: API key in header api_key

Path parameters

job_idinteger required

The job_id returned by Generate image from text or Generate image from image.

Response

OK

statusstring

Job status: queued (accepted, not yet started), in_progress (generating, see progress), completed (result available in result), or failed (generation error).

progressinteger

Completion percentage from 0 to 100. Present while the job is in progress.

Changes

No recorded changes to this operation across all 1 revision of this API.