Videos

Get Videos

get

Get videos

Authorizations

APIKeyHeader

api-keystringRequired

Responses

200

Successful Response

application/json

idstringRequired

namestringOptional

statusstring · enumRequired

An enumeration.

Possible values:

progressinteger · min: -1 · max: 100Optional

The videos rendering progress

Default: 0

req_idstringRequired

draft_idstringRequired

The id of the project created by this video request

source_draft_idstringOptional

recipe_idstringOptional

palette_idstringOptional

The palette_id used in this video

character_idstringOptional

The character_id used in this video

voice_idstringOptional

The character_id used in this video

video_player_urlstringRequired

the final videos url

download_urlstringOptional

get

/videos

HTTPcURLJavaScriptPython

GET /api/v1/videos HTTP/1.1
Host: api.makereals.com
api-key: YOUR_API_KEY
Accept: */*

200

Successful Response

[
  {
    "id": "text",
    "name": "text",
    "status": "started",
    "progress": 0,
    "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"
  }
]

Create Video From Source Draft

post

Create a video based on a source draft or a recipe_id

Authorizations

APIKeyHeader

api-keystringRequired

Header parameters

workspace-idstringOptional

team-idstringOptional

Body

application/json

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.

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/videos

HTTPcURLJavaScriptPython

POST /api/v1/videos HTTP/1.1
Host: api.makereals.com
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "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"
    }
  ]
}

{
  "id": "text",
  "name": "text",
  "status": "started",
  "progress": 0,
  "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"
}

Get Video By Id

get

Get video by id

Authorizations

APIKeyHeader

api-keystringRequired

Path parameters

video_idstringRequired

Responses

200

Successful Response

application/json

idstringRequired

namestringOptional

statusstring · enumRequired

An enumeration.

Possible values:

progressinteger · min: -1 · max: 100Optional

The videos rendering progress

Default: 0

req_idstringRequired

draft_idstringRequired

The id of the project created by this video request

source_draft_idstringOptional

recipe_idstringOptional

palette_idstringOptional

The palette_id used in this video

character_idstringOptional

The character_id used in this video

voice_idstringOptional

The character_id used in this video

video_player_urlstringRequired

the final videos url

download_urlstringOptional

422

Validation Error

application/json

get

/videos/{video_id}

HTTPcURLJavaScriptPython

GET /api/v1/videos/{video_id} HTTP/1.1
Host: api.makereals.com
api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "status": "started",
  "progress": 0,
  "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"
}

List Videos

get

Get videos

Authorizations

APIKeyHeader

api-keystringRequired

Responses

200

Successful Response

application/json

idstringRequired

namestringOptional

statusstring · enumRequired

An enumeration.

Possible values:

progressinteger · min: -1 · max: 100Optional

The videos rendering progress

Default: 0

req_idstringRequired

draft_idstringRequired

The id of the project created by this video request

source_draft_idstringOptional

recipe_idstringOptional

template_idstringOptional

palette_idstringOptional

The palette_id used in this video

character_idstringOptional

The character_id used in this video

voice_idstringOptional

The character_id used in this video

scenesany ofOptional

The videos scene description

or

video_player_urlstringRequired

the final videos url

download_urlstringOptional

correlation_idstringOptional

request correlation id

get

/videos

HTTPcURLJavaScriptPython

GET /api/v1/videos HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

200

Successful Response

[
  {
    "id": "text",
    "name": "text",
    "status": "started",
    "progress": 0,
    "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"
      }
    ]
  }
]

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