Skip to content
SayGMDocs
Dashboard

Create a video job

POST
/videos
curl --request POST \
--url https://api.saygm.com/v1/videos \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "model": "example", "prompt": "example", "seconds": 1, "size": "example", "seed": 1, "image_reference": [ { "image_url": "example", "role": "first_frame" } ] }'

Start video generation and receive a job object. Poll GET /v1/videos/{id} for status; the response includes expires_at for the generated content.

Idempotency-Key
string
>= 1 characters <= 128 characters /^[ -~]+$/

Optional printable key of up to 128 characters. Repeating the same key and request returns the existing job; reusing it for a different request returns 409.

object
model
required

A model id that supports video generation.

string
>= 1 characters
prompt
required

A non-empty prompt of at most 4,000 UTF-8 bytes.

string
>= 1 characters
seconds

Requested duration in seconds; supported values depend on the model.

integer
>= 4 <= 15
size

Requested output dimensions; supported values depend on the model.

string
seed
integer
<= 4294967295
image_reference
Array<object>
>= 1 items <= 9 items
object
image_url
required

A base64 data URL for a PNG, JPEG, or WebP image of at most 2 MiB.

string
/^data:image/(png|jpeg|webp);base64,/
role
required
string
Allowed values: first_frame last_frame reference_image

The created or previously accepted video job.

Media typeapplication/json
object
id
required
string
object
required
string
Allowed value: video
model
required
string
seconds
required

Requested duration in seconds, serialized as a numeric string.

string
size
required
string
created_at
required

Creation time as Unix seconds.

integer
completed_at
required

Completion time as Unix seconds, or null until complete.

integer | null
expires_at
required

Content expiry time as Unix seconds.

integer
status
required
string
Allowed values: queued in_progress completed failed
error
required
Any of:
object
code
required
string
message
required
string
key
additional properties
any
usage
required
Any of:
object
output_video_seconds
required
integer
cost
required

Settled buyer charge in USD.

string
cost_nano_usd
required

The same charge in integer nano-USD.

integer
progress
integer
<= 100
Example
{
"object": "video",
"status": "queued"
}

The request is invalid or the model does not support the requested video options.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The API key is missing or invalid.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The account does not have enough available credit for this video.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The request body did not arrive before the upload timeout (upload_timeout).

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The idempotency key conflicts with a different request.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The request body is too large.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The account has reached a video job or upload concurrency limit.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The upstream video request could not be accepted.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}

The service cannot complete the request right now.

Media typeapplication/json
object
error
required
object
message
required
string
type
required
string
code
required
string
param
required
string | null
key
additional properties
any
charged
boolean
billing_status
string
Allowed values: settled unbilled unknown
potentially_charged
boolean
key
additional properties
any
Example
{
"billing_status": "settled"
}