Read a generation

One generation and each output’s status, asset and error. Send Prefer: wait=N to hold the response until it ends. Reads never start or repeat work.

Needs the generations:read scope.

GET /generations/{id}

Read a generation

cURL

curl --request GET \
  --url https://api.zerogen.com/v1/generations/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "projectId": "<string>",
  "model": "<string>",
  "modelVersion": "<string>",
  "status": "queued",
  "outputs": [
    {
      "index": 4503599627370495,
      "status": "queued",
      "asset": {
        "id": "<string>",
        "mimeType": "<string>",
        "width": 4503599627370495,
        "height": 4503599627370495,
        "durationMs": 4503599627370495,
        "resourceUri": "<string>"
      },
      "error": {
        "code": "<string>",
        "message": "<string>",
        "retryable": true,
        "param": "<string>",
        "details": {}
      },
      "warnings": [
        {
          "code": "<string>",
          "message": "<string>"
        }
      ],
      "draft": {
        "expiresAt": "2023-11-07T05:31:56Z",
        "upscalable": true,
        "upscale": "upscaling",
        "finalResolution": "<string>",
        "finalAssetId": "<string>"
      }
    }
  ],
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "param": "<string>",
    "details": {}
  },
  "billing": {
    "mode": "platform",
    "state": "held",
    "quotedMicroUsd": 4503599627370495,
    "heldMicroUsd": 4503599627370495,
    "chargedMicroUsd": 4503599627370495,
    "hold": {
      "state": "running",
      "endedAt": "2023-11-07T05:31:56Z"
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.

Headers

Prefer · string

wait=N holds the response up to N seconds (at most 60) until the generation ends.

Pattern: ^wait=\d+$

Example:

"wait=30"

Path Parameters

id · string · required

The generation's ID

Response

200

application/json

The generation.

id · string · required

projectId · string · required

The project that holds the outputs

model · string | null · required

Maximum string length: 200

Pattern: ^[a-z0-9]+(?:[.-][a-z0-9]+)*\/[a-z0-9]+(?:[.-][a-z0-9]+)*\/[a-z0-9]+(?:[.-][a-z0-9]+)*$

modelVersion · string | null · required

status · enum<string> · required

Available options: queued, running, succeeded, partial, failed, cancelled

outputs · object[] · required

Show child attributes

error · object | null · required

Show child attributes

billing · object · required

Show child attributes

createdAt · string<date-time> · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

startedAt · string<date-time> | null · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

finishedAt · string<date-time> | null · required

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$