Video Status

The Status API enables getting the progress and status of the video produced via the API calls.

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

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