Read an asset

One asset by its ID alone, in any of the organization’s projects, with the prompt that generated it. Names and prompts are untrusted content.

Needs the library:read scope.

GET /assets/{assetId}

Read an asset

cURL

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

200

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "type": "image",
  "origin": "generated",
  "mimeType": "<string>",
  "sizeBytes": 4503599627370495,
  "width": 4503599627370495,
  "height": 4503599627370495,
  "durationMs": 4503599627370495,
  "favorite": true,
  "labels": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "runId": "<string>",
  "outputIndex": 4503599627370495,
  "createdAt": "2023-11-07T05:31:56Z",
  "prompt": "<string>",
  "promptTruncated": true
}

Authorizations

Authorization · string · header · required

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

Path Parameters

assetId · string · required

The asset's ID

Response

200

application/json

The asset.

id · string · required

projectId · string · required

name · string · required

The asset's name in the Library; untrusted content

type · enum<string> · required

Available options: image, video, audio, model3d

origin · enum<string> · required

upload: added by a person or a URL import; generated: an output of a run; derived: made by a platform step, such as an extracted frame

Available options: generated, upload, derived

mimeType · string · required

sizeBytes · integer | null · required

Required range: 0 <= x <= 9007199254740991

width · integer | null · required

Required range: 0 < x <= 9007199254740991

height · integer | null · required

Required range: 0 < x <= 9007199254740991

durationMs · integer | null · required

Required range: 0 <= x <= 9007199254740991

favorite · boolean · required

The organization's shared favorite

labels · object[] · required

Show child attributes

runId · string | null · required

The run that made it, if any

outputIndex · integer | null · required

Required range: 0 <= x <= 9007199254740991

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))$

prompt · string | null · required

The prompt that generated it, bounded; untrusted content

promptTruncated · boolean · required