Skip to main content
POST
Create a Video

Authorizations

X-App-ID
string
header
required

Your Spatius App ID.

X-API-Key
string
header
required

The API key bound to the App ID.

Body

application/json
avatarId
string<uuid>
required

An existing public Avatar, an Avatar actively assigned to your account, or an Avatar explicitly allowed for your account. Access is checked on every creation and before rendering.

audioUrl
string<uri>
required

Audio source, at most 500 MiB. Use a public HTTP(S) URL without embedded credentials. Signed query parameters are supported. Keep the URL accessible for the preparation window of up to 30 minutes. Each transfer has a five-minute limit. The source must return a supported Content-Type; raw PCM and application/octet-stream are not supported. See Media requirements.

Required string length: 1 - 4096
Pattern: ^https?://[^/?#@\s]+([/?#].*)?$
backgroundUrl
string<uri>

Optional background image, at most 50 MiB. Use a public HTTP(S) URL without embedded credentials. Signed query parameters are supported. Keep the URL accessible for the preparation window of up to 30 minutes. Each transfer has a five-minute limit. The source must return a supported Content-Type; raw PCM and application/octet-stream are not supported. See Media requirements.

Required string length: 1 - 4096
Pattern: ^https?://[^/?#@\s]+([/?#].*)?$
name
string

Optional job name. When omitted, Spatius generates a name from the job ID.

Required string length: 1 - 128
requestId
string<uuid>

Optional retry key, shared across Apps owned by your account. The same requestId and normalized input return the existing job without consuming creation quota again. Different input with the same key returns HTTP 409. Omitted settings and their explicit defaults are equivalent. Omit this field to create a new job on every call.

video
object

Optional presentation settings. Width and height must be even, and their effective product must not exceed 2,073,600 pixels, including defaults for omitted dimensions. Encoding settings are managed by Spatius. Opening and closing transitions are included even when lead-in and lead-out are zero.

Response

Job accepted, or an existing job returned for a retry.

jobId
string<uuid>
required

The accepted job ID.

status
enum<string>
required

New jobs return queued. A retry returns the existing job's current status, which may already be terminal.

Available options:
queued,
processing,
succeeded,
failed,
expired
createdAt
string<date-time>
required

Original acceptance time, including on a retry.