For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportStatusTry now
DocumentationAPI Reference
DocumentationAPI Reference
    • API Overview
  • API Guides
    • Authentication
    • Concurrency & Rate Limits
    • Batch Processing
    • Webhooks
  • Generate API
    • POSTCreate Generation
    • POSTCreate Generation with Files
    • GETGet Generation
    • GETList Generations
    • POSTEstimate Cost
  • Batch API
    • POSTCreate Batch
    • GETGet Batch
    • GETList Batches
  • Assets API
    • GETList Assets
    • GETGet Asset
  • Models API
    • GETList Models
  • Webhooks Payload Reference
LogoLogo
SupportStatusTry now
Generate API

List Generations

GET
/v2/generations
GET
/v2/generations
$curl https://api.sync.so/v2/generations \
>     -H "x-api-key: <apiKey>"
1[
2  {
3    "createdAt": "2024-01-15T09:30:00Z",
4    "id": "id",
5    "input": [
6      {
7        "type": "video",
8        "url": "https://example.com/video.mp4"
9      }
10    ],
11    "model": "lipsync-2",
12    "status": "PENDING",
13    "error": "error",
14    "options": {},
15    "outputDuration": 1.1,
16    "outputUrl": "",
17    "webhookUrl": ""
18  }
19]
Was this page helpful?
Previous

Estimate Cost

Next
Built with

Authentication

x-api-keystring
API Key authentication via header

Query parameters

statuslist of enumsOptional

Filter generations by status. Accepts multiple statuses as a comma-separated list.

Allowed values:
idslist of stringsOptional

Filter generations by ID. Accepts multiple IDs as a comma-separated list.

sourcelist of stringsOptional

Filter generations by source. Accepts multiple sources as a comma-separated list.

Response

Generations retrieved successfully
createdAtdatetime
The date and time the generation was created.
idstring
A unique identifier for the generation.
inputlist of objects
An array of input objects used for generation.
modelenum
The name of the model used for generation.
Allowed values:
statusenum
The status of the generation.
Allowed values:
errorstring
The error message if the generation failed.
error_codestring
The error code if the generation failed.
optionsobject
Options for the generation.
outputDurationdouble
The duration of the output media.
outputUrlstring
The URL of the output media.
segmentslist of objects
The segments of the generation.
segmentOutputUrlstring
The URL of the segment output media.
webhookUrlstring
The URL to the webhook endpoint.

Errors

401
Unauthorized Error
500
Internal Server Error