Skip to main content
GET
Get Studio Image
Returns the status of a Studio image job in the authenticated key scope. Poll it after Generate Studio Image until output_url is set or status is failed. Every 5 seconds is a good interval. CLI: genviral studio-image-status --image-id <id>, or genviral studio-generate-image ... --wait to start and poll in one command.

Path Parameters

string
required
Image UUID (image_id) returned by POST /api/partner/v1/studio/images/generate.

Status Values

  • processing - still generating; output_url is null
  • succeeded - output_url and file_id are set
  • failed - error says why; credits are refunded
The error field is present on every response. It is null unless the job failed, so check status or output_url, not the presence of error.

Example

Recovering a lost image_id

If your client lost the image_id, list recent results with List Studio Creations (kind=image, limit 1 to 48) and match on prompt_excerpt.

Error Responses

  • 404 image_not_found
  • 422 invalid_path
  • 401 - authentication failed (missing/invalid/revoked token)