Videos

Get Videos

get

Get videos

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.makereals.com/api/v1/videos' \
  --header 'api-key: YOUR_API_KEY'

200

200

[
  {
    "id": "text",
    "name": "text",
    "status": "started",
    "progress": 1,
    "req_id": "text",
    "draft_id": "text",
    "source_draft_id": "text",
    "recipe_id": "text",
    "palette_id": "text",
    "character_id": "text",
    "voice_id": "text",
    "scenes": [
      {
        "name": "text",
        "media": [
          "text"
        ],
        "texts": [
          "text"
        ],
        "transcript": "text",
        "voice_recording_url": "text"
      }
    ],
    "video_player_url": "text",
    "download_url": "text"
  }
]

Successful Response

Create Video From Source Draft

post

Create a video based on a source draft or a recipe_id

Authorizations

Header parameters

workspace-idstringoptional

team-idstringoptional

Body

namestringoptional

The name of the project created by this request

source_draft_idstringoptional

The id of the project your video will be based on.

recipe_idstringoptional

The id of the recipe your video will be based on.

folder_idstringoptional

The id of the folder your video will be based on.

palette_idstringoptional

The palette_id of a color-palette you would like to use instead of the source project one. if no value is given, the source projects color-palette will be used.

character_idstringoptional

The character_id of a character you would like to use instead of the source projects one. if no value is given, the source projects character will be used.

voice_idstringoptional

The id of a voice you would like to use instead of the source projects one. if no value is given, the source projects voice will be used.

scenesobject[]required

Each object in this array will represent a scene in the final video. the video will be generated based on this arrays order (the first object in this array will represent the first scene in the video etc.). The length of this array must be equal to the number of the source projects scenes.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.makereals.com/api/v1/videos' \
  --header 'api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "source_draft_id": "text",
    "recipe_id": "text",
    "folder_id": "text",
    "palette_id": "text",
    "character_id": "text",
    "voice_id": "text",
    "scenes": [
      {
        "name": "text",
        "media": [
          "text"
        ],
        "texts": [
          "text"
        ],
        "transcript": "text",
        "voice_recording_url": "text"
      }
    ]
  }'

201

422

201

{
  "id": "text",
  "name": "text",
  "status": "started",
  "progress": 1,
  "req_id": "text",
  "draft_id": "text",
  "source_draft_id": "text",
  "recipe_id": "text",
  "palette_id": "text",
  "character_id": "text",
  "voice_id": "text",
  "scenes": [
    {
      "name": "text",
      "media": [
        "text"
      ],
      "texts": [
        "text"
      ],
      "transcript": "text",
      "voice_recording_url": "text"
    }
  ],
  "video_player_url": "text",
  "download_url": "text"
}

Successful Response

Get Video By Id

get

Get video by id

Authorizations

Path parameters

video_idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.makereals.com/api/v1/videos/{video_id}' \
  --header 'api-key: YOUR_API_KEY'

200

422

200

{
  "id": "text",
  "name": "text",
  "status": "started",
  "progress": 1,
  "req_id": "text",
  "draft_id": "text",
  "source_draft_id": "text",
  "recipe_id": "text",
  "palette_id": "text",
  "character_id": "text",
  "voice_id": "text",
  "scenes": [
    {
      "name": "text",
      "media": [
        "text"
      ],
      "texts": [
        "text"
      ],
      "transcript": "text",
      "voice_recording_url": "text"
    }
  ],
  "video_player_url": "text",
  "download_url": "text"
}

Successful Response

List Videos

get

Get videos

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/videos' \
  --header 'api-key: YOUR_API_KEY'

200

200

[
  {
    "id": "text",
    "name": "text",
    "status": "started",
    "progress": 1,
    "req_id": "text",
    "draft_id": "text",
    "source_draft_id": "text",
    "recipe_id": "text",
    "template_id": "text",
    "palette_id": "text",
    "character_id": "text",
    "voice_id": "text",
    "scenes": [
      {
        "name": "text",
        "type": "override_scene",
        "media": [
          "text"
        ],
        "texts": [
          "text"
        ],
        "transcript": "text",
        "voice_recording_url": "text"
      }
    ],
    "video_player_url": "text",
    "download_url": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "correlation_id": "text",
    "palette": [
      {
        "color": "text"
      }
    ],
    "global_media_elements": [
      {
        "id": "text",
        "url": "https://example.com",
        "media_id": "text"
      }
    ]
  }
]

Successful Response

Get Video Metadata

GET /api/v1/videos/{video_id}/metadata

Headers

Name	Value
Content-Type	application/json
api-key	<key>

Response

200

{
  "duration": 0,
  "scenes_metadata": [
    {
      "scene_index": 0,
      "start_time": 0,
      "duration": 0
    }
  ]
}

422

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}