Create video

Create video

post

Before using this endpoint, call one of the following endpoints to generate and review your video's content:

• Draft video
• Draft video from URL
• Draft video from script
• Draft quiz video
• Draft news video

Once you (or your LLM) are happy, you can pass the content to this endpoint to create and render the video.

Authorizations

bearerAuth

Body

application/json

content_typestring · enumOptionalDefault: CustomPossible values:

localestring · enumOptional

Locale for the generated video.

Default: autoPossible values:

image_style_idstring · uuidOptional

The ID of the image style to use. Use the List image styles endpoint to get a list of available image styles. If left empty, the AI chooses.

image_modelstring · enumOptional

Image model for the generated video.

Possible values:

image_qualitystring · enumOptional

Image quality for the generated video.

Possible values:

image_style_raw_modebooleanOptional

Whether to use the raw image style mode. If true, the image style will be ignored.

image_style_custom_promptstringOptional

Custom prompt for the image style. If you provide a custom prompt, the image style will be ignored.

animation_modelstring · enumOptional

Default animation model for scene images when not specified individually.

Possible values:

animation_model_presetstring · enumOptional

Default animation preset for scene images when not specified individually.

Possible values:

connection_idsstring · uuid[]Required

List of publishing connection ids. Use the List connections endpoint to get a list of available connections

aspect_ratiostring · enumOptional

Aspect ratio of the video. Not required for News videos.

Default: 9:16Possible values:

voice_playback_ratenumber · min: 50 · max: 200Optional

Voice playback speed percentage.

Default: 100

voice_volumenumber · max: 100Optional

Voice volume percentage.

Default: 100

soundtrack_playback_ratenumber · min: 50 · max: 200Optional

Soundtrack playback speed percentage.

Default: 100

soundtrack_volumenumber · max: 100Optional

Soundtrack volume percentage.

Default: 100

titlestringRequired

The title of the video.

captionstringRequired

The description shown beside the video when posted to social media.

voice_idstringOptional

The voice to use for speech generation. See the List voices endpoint. If left empty, the AI chooses.

soundtrack_idstring · uuidOptional

Id of the soundtrack to use for background music. See the List music endpoint for available genres, and the List music tracks endpoint for available soundtracks. If left empty, the AI chooses.

publish_atstringOptional

Scheduled time for publishing the video. Format in ISO 8601. If left empty, it will be published 1 hour after the video is created.

Responses

200

Successful response

application/json

400

Invalid request

application/json

401

Unauthorized request

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/videos HTTP/1.1
Host: shortgenius.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1265

{
  "content_type": "Custom",
  "locale": "auto",
  "image_style_id": "123e4567-e89b-12d3-a456-426614174000",
  "image_model": "OpenAI",
  "image_quality": "low",
  "image_style_raw_mode": true,
  "image_style_custom_prompt": "text",
  "animation_model": "None",
  "animation_model_preset": "fully_animated",
  "connection_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "aspect_ratio": "9:16",
  "voice_playback_rate": 100,
  "voice_volume": 100,
  "soundtrack_playback_rate": 100,
  "soundtrack_volume": 100,
  "title": "text",
  "caption": "text",
  "scenes": [
    {
      "title": null,
      "caption": "text",
      "image_query": null,
      "first_image_description": null,
      "second_image_description": null,
      "first_image_animation_model": "None",
      "second_image_animation_model": "None"
    }
  ],
  "quiz": {
    "questions": [
      {
        "question": "text",
        "options": [
          {
            "text": "text",
            "correct": true
          }
        ]
      }
    ],
    "results": {
      "header": "text",
      "explanation": "text",
      "categories": [
        {
          "score_range": "text",
          "title": "text"
        }
      ]
    }
  },
  "ad": {
    "product_id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "JustTheHook",
    "ugc_media": {
      "url": null,
      "deletedAt": null,
      "metadata": null,
      "lastError": null,
      "type": "text",
      "source": "Ugc",
      "category": "text",
      "data": {
        "id": "text",
        "hook": null
      },
      "state": "text"
    },
    "media_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "voice_id": "text",
  "soundtrack_id": "123e4567-e89b-12d3-a456-426614174000",
  "publish_at": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "title": null,
  "caption": null,
  "created_at": "text",
  "updated_at": null,
  "series_id": "123e4567-e89b-12d3-a456-426614174000",
  "publishing_state": "pending",
  "publish_at": null
}