GET
/
v2
/
generate
/
{id}
curl --request GET \
  --url https://api.sync.so/v2/generate/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "model": "<string>",
  "input": [
    {
      "type": "<string>",
      "url": "<string>"
    }
  ],
  "webhookUrl": {},
  "options": {},
  "outputUrl": {},
  "outputDuration": {},
  "error": "<string>"
}

​
Getting started

Retrieve the status and result of a previously created generation.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Job ID

Response

200
application/json
Job status retrieved successfully
​
id
string
required

A unique identifier for the generation.

​
createdAt
string
required

The date and time the generation was created.

​
status
enum<string>
required

The status of the generation.

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
REJECTED,
CANCELED
​
model
string
required

The name of the model used for generation.

​
input
object[]
required

An array of input objects containing type and URL.

​
webhookUrl
object

The URL to the webhook endpoint.

​
options
object

Options for the generation.

​
outputUrl
object

The URL of the output media.

​
outputDuration
object

The duration of the output media.

​
error
string

The error message if the generation failed.

create a new generation jobget multiple generations for an organization