Read a model

One model and the JSON Schema (2020-12) that POST /generations validates its requests against. A deprecated model sends Deprecation and Sunset.

Needs the models:read scope.

GET /models/{vendor}/{model}/{operation}

Read a model

cURL

curl --request GET \
  --url https://api.zerogen.com/v1/models/{vendor}/{model}/{operation} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "capability": "image",
  "operation": "generate",
  "status": "active",
  "sunsetAt": "2023-11-07T05:31:56Z",
  "requestSchema": {}
}

Authorizations

Authorization · string · header · required

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

Path Parameters

vendor · string · required

The company that makes the model, such as google

model · string · required

The model, such as nano-banana-2

operation · string · required

The operation, such as generate

Response

200

application/json

The model.

id · string · required

Maximum string length: 200

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

name · string · required

capability · enum<string> · required

Available options: image, video, speech

operation · enum<string> · required

Available options: generate, edit, inpaint, remix, text-to-vector, text-to-video, image-to-video, first-last-frame-to-video, keyframes-to-video, reference-to-video, audio-to-video, video-to-video, extend-video, motion-control, clean-plate, render-to-real, hdr, outpaint, reference-video-to-video, text-to-speech

status · enum<string> · required

Available options: active, deprecated

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

A deprecated model refuses new requests from this time

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

requestSchema · object · required

JSON Schema (2020-12) for POST /v1/generations with this model; x-roles lists each input role's accepted media and limits

Show child attributes