API Reference
Create a video generation job
Generate a video from a prompt and optional input reference.
POST
/
v1
/
videos
Create a video generation job
curl --request POST \
--url https://api.synapsai.cloud/v1/videos \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"prompt": "<string>",
"input_reference": "<string>",
"seconds": 4,
"size": "1280x720",
"fps": 16,
"num_inference_steps": 25,
"guidance_scale": 5
}
'import requests
url = "https://api.synapsai.cloud/v1/videos"
payload = {
"model": "<string>",
"prompt": "<string>",
"input_reference": "<string>",
"seconds": 4,
"size": "1280x720",
"fps": 16,
"num_inference_steps": 25,
"guidance_scale": 5
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"object": "video",
"created_at": 123,
"model": "<string>",
"seconds": 123,
"size": "<string>",
"status": "queued",
"completed_at": 123,
"error": {
"code": "<string>",
"message": "<string>"
},
"expires_at": 123,
"prompt": "<string>"
}Body
application/json
Video creation request
Model ID to use
Text prompt describing the video
Optional reference video or asset as URL, data URI, base64 string, or file path
Response
200 - application/json
Video generation job created
Structured information describing a generated video job
Available options:
video Video generation lifecycle states
Available options:
queued, in_progress, completed, failed Video generation error details
Show child attributes
Show child attributes
⌘I
Create a video generation job
curl --request POST \
--url https://api.synapsai.cloud/v1/videos \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"prompt": "<string>",
"input_reference": "<string>",
"seconds": 4,
"size": "1280x720",
"fps": 16,
"num_inference_steps": 25,
"guidance_scale": 5
}
'import requests
url = "https://api.synapsai.cloud/v1/videos"
payload = {
"model": "<string>",
"prompt": "<string>",
"input_reference": "<string>",
"seconds": 4,
"size": "1280x720",
"fps": 16,
"num_inference_steps": 25,
"guidance_scale": 5
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"object": "video",
"created_at": 123,
"model": "<string>",
"seconds": 123,
"size": "<string>",
"status": "queued",
"completed_at": 123,
"error": {
"code": "<string>",
"message": "<string>"
},
"expires_at": 123,
"prompt": "<string>"
}