---
title: "Generate a video"
method: POST
path: "/videos/generate"
tags: ["videos"]
---

# Generate a video

`POST /videos/generate`

## Request

- Base URL: `https://api.waymark.com/v1`
- URL: `https://api.waymark.com/v1/videos/generate`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in header `Authorization`

## Request body

- VideoGenerationRequest
  - `topicId` string, uuid
  - `topic` Topic
    - `sourceUrl` string, uri
    - `data` TopicData
      - `name` string
      - `address` TopicAddress
        - `streetAddress1` string
        - `streetAddress2` string
        - `streetAddress3` string
        - `city` string
        - `state` string
        - `postalCode` string
        - `countryCode` string
      - `phone` string
      - `websiteUrl` string
      - `description` string
      - `industry` string
      - `images` string[]
      - `logoImageUrl` string, uri
  - `customerMetadata` string
  - `accountGuid` string, uuid, required
  - `outputParameters` OutputParameters
    - `aspectRatio` '16:9' | '4:5', required
    - `duration` 5 | 15 | 30, required
  - `templateVariantId` string
  - `customization` Customization
    - `instructions` string
    - `vibe` 'Fun' | 'Neutral' | 'Professional' | 'Laid-Back' | 'Inspiring'
    - `languageCode` 'en-US' | 'en-GB' | 'en-AU' | 'en-NZ' | 'es' | 'de' | 'fr' | 'it-IT' | 'pt'
  - `webhookUrl` string, uri
  - `title` string: Optional title to set on the generated video.

## Response `202`

Video generation request accepted

- VideoGenerationAccepted
  - `requestId` string, uuid, required
  - `videoId` string, uuid, required
  - `topicId` string, uuid, required
  - `previewUrl` string, uri, required
  - `editUrl` string, uri, required

## Other responses

- `400`: Bad request
- `409`: Duplicate request
- `500`: Internal server error

---

[API](https://skmtc.dev/waymark/apis/waymark-api-v1.md) - [All operations](https://skmtc.dev/waymark/apis/waymark-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/waymark/apis/waymark-api-v1/revisions/0b315115f107?raw)