get a generation
generations_getTrack a sync generation by ID to check its status and get the output media URL when completed or the error and error code if it fails.
Instructions
Read one sync. generation by id: its status (PENDING or PROCESSING while it runs; COMPLETED, FAILED or REJECTED when final), outputMediaUrl once COMPLETED, and error and errorCode after FAILED or REJECTED.
Use it to follow a generation by the id its create call returned (lipsync_create, dubbing_create, lipsync_create-timeline or dialogue-videos_create, when available). jobs_get and jobs_wait, when available, read the same generation in a generic job shape that can add a completion percent while it runs.
Not for: finding a past id (generations_list, or projects_list-generations when available); what it cost (generations_get-costs when available); its inputs when the user explicitly continues it (generations_get-continuation).
Waiting: pass wait: true and leave out timeout to keep reading on the server for up to about 50 seconds; it returns once the generation is final, or its latest state. If it is still running, call again with the same id; never resubmit, since a new create starts a separate generation that is billed or counted against free limits.
Result: copy the exact structuredContent.outputMediaUrl string verbatim; it is signed, so it must not be reconstructed, shortened, or edited (outputUrl is a deprecated alias with the same value). On FAILED or REJECTED, tell the user the error and errorCode.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Generation id returned by a create tool or generations_list. | |
| wait | No | Wait on the server until the job finishes or about 50 seconds pass, then return its latest state. If it is still running, call again with wait: true instead of sleeping. | |
| include | No | Additional information to include in the response | |
| timeout | No | Seconds each read holds (1-10). Leave it out; wait: true reads for about 50 seconds. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||