Sign in

v1

latestSwagger 2.02026-07-176096209.1 KB
v2

Retrieve the full status of an Asynchronous generation request

This request will include all already generated images in download URL or base64 encoded .webp files. As such, you are requested to not retrieve this endpoint often. Instead use the /check/ endpoint first This endpoint is limited to 10 request per minute

get/v2/generate/status/{id}

Headers

Client-Agentstring

The client name and version

X-Fieldsstring mask

An optional fields mask

Response

Async Request Full Status

finishedinteger

The amount of finished jobs in this request.

processinginteger

The amount of still processing jobs in this request.

restartedinteger

The amount of jobs that timed out and had to be restarted or were reported as failed by a worker.

waitinginteger

The amount of jobs waiting to be picked up by a worker.

doneboolean

True when all jobs in this request are done. Else False.

faultedboolean

True when this request caused an internal server error and could not be completed.

wait_timeinteger

The expected amount to wait (in seconds) to generate all jobs in this request.

queue_positioninteger

The position in the requests queue. This position is determined by relative Kudos amounts.

kudosnumber

The amount of total Kudos this request has consumed until now.

is_possibleboolean

If False, this request will not be able to be completed with the pool of workers currently available.

sharedboolean

If True, These images have been shared with LAION.

Example response

{
  "generations": [
    {
      "state": "ok",
      "gen_metadata": [
        {
          "type": "lora",
          "value": "download_failed"
        }
      ]
    }
  ]
}