Generate Video

Submit a video generation job for a given domain. Demomatic uses your prompt to autonomously record the application, generate narration, and assemble the final video. Most requests are queued and processed asynchronously. Poll GET /v1/videos to check for the completed video. In some environments, the video may be returned synchronously in the same response.

Endpoint

POST /v1/videos/:domain_id

Authentication

Pass an all_access API key as a Bearer token in the Authorization header.

string

required

Your API key. Format: Bearer <api_key>. Must have all_access permission — read-only keys cannot call this endpoint.

Read-only API keys cannot call this endpoint. You must use a key with all_access permission.

Path parameters

number

required

The ID of the domain to generate a video for. The domain must belong to your account.

Request body

string

Natural language description of the demo to generate. Describe the user flow, feature, or scenario you want to showcase.

string

required

Font to use for captions and text overlays. Valid values: "Inter", "OpenSans", "Playwrite", "Poppins", "Roboto".

boolean

required

When true, captions are added to the video.

boolean

required

When true, B-roll footage is included in the video.

string

Background music track. Valid values: "observer", "lawrence", "all_i_am", "lust", "denied_access", "75_and_lower". Omit to use no music.

string | null

Voice model for narration. Valid values: "ash", "onyx", "nova", "fable". Pass null to omit narration.

string | null

Background style ID. Pass null to use no custom background.

object[]

List of recipient contacts used to personalize the video narration and on-screen text.

Show contact properties

string

Recipient’s email address. Required if you want to notify them after generation.

string

Recipient’s full name.

string

Recipient’s job title.

string

Recipient’s company name.

string

Recipient’s industry.

string

Any additional context to incorporate into the personalization.

boolean

When true, contacts with a valid email are emailed a link to the video after generation completes. Defaults to false.

Response

Generation requests are almost always queued. The response shape depends on whether the job was queued or completed synchronously.

Queued response

object

required

Hide properties

number

required

ID of the queued video job. Use this to correlate status when polling.

string

required

Job status. Always "queued" for this response shape.

string

required

Human-readable message with polling instructions. Poll GET /v1/videos until the new video appears.

Synchronous response

object

required

Hide properties

object

required

Show video properties

number

required

Unique video identifier.

number

required

ID of the domain this video was generated for.

string

required

Human-readable name assigned to the video.

string

required

Pre-signed URL to stream or download the video.

string

required

ISO 8601 timestamp when the video was created.

string

required

ISO 8601 timestamp when the video was last updated.

Error responses

Status	Description
`400`	The `domain_id` is not a valid number, or the request body failed validation.
`404`	No domain found with the given ID, or the domain belongs to a different account.

Examples

curl --request POST \
  --url https://api.demomatic.tech/v1/videos/45 \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "prompt": "Show how a user signs up and completes onboarding",
    "font": "Poppins",
    "captions": true,
    "bRoll": false,
    "music": "observer",
    "voiceId": null,
    "backgroundId": null
  }'

const domainId = 45;

const response = await fetch(`https://api.demomatic.tech/v1/videos/${domainId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    prompt: 'Show how a user signs up and completes onboarding',
    font: 'Poppins',
    captions: true,
    bRoll: false,
    music: 'observer',
    voiceId: null,
    backgroundId: null,
  }),
});

const { data } = await response.json();
console.log(data);

Queued response

200

{
  "data": {
    "job_id": 789,
    "status": "queued",
    "message": "Video job queued. Poll GET /v1/videos or GET /jobs/:domain_id for completion."
  }
}

Synchronous response

200

{
  "data": {
    "video": {
      "id": 123,
      "domain_id": 45,
      "url": "https://signed-url.example.com/video.mp4",
      "created_at": "2024-01-15T10:00:00.000Z",
      "updated_at": "2024-01-15T10:05:00.000Z",
      "filename": "Product Tour"
    }
  }
}

Personalized generation with contacts

curl --request POST \
  --url https://api.demomatic.tech/v1/videos/45 \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "prompt": "Showcase the analytics dashboard",
    "font": "Poppins",
    "captions": true,
    "bRoll": false,
    "contacts": [
      {
        "name": "Alice Smith",
        "email": "alice@example.com",
        "jobTitle": "Head of Marketing",
        "company": "Acme Corp",
        "industry": "SaaS"
      }
    ],
    "notify_contacts": true
  }'

const domainId = 45;

const response = await fetch(`https://api.demomatic.tech/v1/videos/${domainId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    prompt: 'Showcase the analytics dashboard',
    font: 'Poppins',
    captions: true,
    bRoll: false,
    contacts: [
      {
        name: 'Alice Smith',
        email: 'alice@example.com',
        jobTitle: 'Head of Marketing',
        company: 'Acme Corp',
        industry: 'SaaS',
      },
    ],
    notify_contacts: true,
  }),
});

const { data } = await response.json();
console.log(data);

Overview

Videos

Domains

Endpoint

Authentication

Path parameters

Request body

Response

Queued response

Synchronous response

Error responses

Examples

Queued response

Synchronous response

Personalized generation with contacts

​Endpoint

​Authentication

​Path parameters

​Request body

​Response

​Queued response

​Synchronous response

​Error responses

​Examples

​Queued response

​Synchronous response

​Personalized generation with contacts

Endpoint

Authentication

Path parameters

Request body

Response

Queued response

Synchronous response

Error responses

Examples

Queued response

Synchronous response

Personalized generation with contacts