v1

`GET /v1/images/{request_id}`: 202 while pending, 200 with `data` when done or with `error` when failed (a failed generation is a body, not an HTTP error, so pollers do not retry-storm).

get/v1/images/{request_id}

Request

  • Base URL: https://docs.x.ai (the document declares no server; this is the origin it was published from)
  • URL: https://docs.x.ai/v1/images/{request_id}
  • Auth: HTTP bearer

Path parameters

request_idstring required

The deferred request id returned by a previous image request.

Response

The generation finished.

request_idstring required

The polled request id.

statusstring required

"pending", "done" or "failed".

Changes

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