> ## Documentation Index
> Fetch the complete documentation index at: https://docs.genviral.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Studio Image

> Poll Studio image generation status by `image_id`.

Returns the status of a Studio image job in the authenticated key scope. Poll it after
[Generate Studio Image](https://docs.genviral.io/api-reference/generate-studio-image.md) 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

**imageId** `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

```bash theme={null}
curl --request GET \
  --url 'https://www.genviral.io/api/partner/v1/studio/images/33333333-3333-4333-8333-333333333333' \
  --header 'Authorization: Bearer <token>'
```

```json Response theme={null}
{
  "ok": true,
  "code": 200,
  "message": "Image status retrieved",
  "data": {
    "image_id": "33333333-3333-4333-8333-333333333333",
    "status": "succeeded",
    "output_url": "https://cdn.vireel.io/images/studio-image-33333333-3333-4333-8333-333333333333.png",
    "error": null,
    "file_id": "11111111-1111-1111-1111-111111111111"
  }
}
```

## Recovering a lost image\_id

If your client lost the `image_id`, list recent results with
[List Studio Creations](https://docs.genviral.io/api-reference/list-studio-creations.md) (`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)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.