Blueprint - Quick Start

Welcome to the Quick Start guide for Video Creation using a Blueprint! This guide will walk you through the essential steps to create your video in no time.

PreviousGet Your API Keys NextDynamic - Quick Start

Last updated 1 year ago

Blueprint - Quick Start

Welcome to the Quick Start guide for Video Creation using a Blueprint! This guide will walk you through the essential steps to create your video in no time.

Get your API keys

Create your first Base Project in HourOne

Create a project by choosing from one of our templates, give the project a name, and create a project based on it by clicking the Use This Template button.

Your project will be created with prefilled content.

Configure the number of scenes you would like your base project to have. you can do so by clicking on the deleted scene and adding scene buttons.

Choose layouts for the scenes. You can open the layout panel by clicking on the “scene” button on the right-side panel.

Layouts are simply a definition of how the scene will look like, for example, a scene with an image, a scene with some text, and more.

Make your first request

To easily create your first request we recommend clicking on the Copy API curl button which will generate a curl command you can use to generate a video.

The copied command will include the body of the request in the form of a JSON, you will be able to enter your data and replace the values within the JSON.

Now paste in your favorite tool, for example, Postman.

Don't forget to enter your API key

Once you have modified the JSON use your API key to make a call to the videos endpoint.

Good to know: the DraftID of your project can be found in the project’s editor URL

The number of scenes sent in the request must be equal to the base project’s number of scenes.

Example of a draft with 3 scenes,

{
    "source_draft_id": "<your draft_id here>",
    "character_id": "<optional>", # if you wish to override base
    "voice_id": "<optional>", # if you wish to override the base
    "scenes": [
        {
            "name": "SCENE 1",
            "transcript": "this is the first scenes transcript"
        },
        {
            "name": "SCENE 2",
            "media": [
                "https://cdn.searchenginejournal.com/wp-content/uploads/2018/04/durable-urls.png"
            ],
            "texts": [
                "this is the second scenes title"
            ],
            "transcript": "this is the second scenes transcript"
        },
        {
            "name": "SCENE 3",
            "texts": [
                "this is the third scenes title"
            ],
            "transcript": "this is the third scenes transcript"
        }
    ]
}

Get the video status

Using the id received in the video creation call you will be able to poll the status of your video by calling the following API

You can always go to the Reals platform and see your videos and status there.

PreviousGet Your API Keys NextDynamic - Quick Start

Last updated 1 year ago

Get your API keys

Create your first Base Project in HourOne

Create a project by choosing from one of our templates, give the project a name, and create a project based on it by clicking the Use This Template button.

Your project will be created with prefilled content.

Configure the number of scenes you would like your base project to have. you can do so by clicking on the deleted scene and adding scene buttons.

Choose layouts for the scenes. You can open the layout panel by clicking on the “scene” button on the right-side panel.

Layouts are simply a definition of how the scene will look like, for example, a scene with an image, a scene with some text, and more.

Make your first request

To easily create your first request we recommend clicking on the Copy API curl button which will generate a curl command you can use to generate a video.

The copied command will include the body of the request in the form of a JSON, you will be able to enter your data and replace the values within the JSON.

Now paste in your favorite tool, for example, Postman.

Don't forget to enter your API key

Once you have modified the JSON use your API key to make a call to the videos endpoint.

Good to know: the DraftID of your project can be found in the project’s editor URL

The number of scenes sent in the request must be equal to the base project’s number of scenes.

Example of a draft with 3 scenes,

{
    "source_draft_id": "<your draft_id here>",
    "character_id": "<optional>", # if you wish to override base
    "voice_id": "<optional>", # if you wish to override the base
    "scenes": [
        {
            "name": "SCENE 1",
            "transcript": "this is the first scenes transcript"
        },
        {
            "name": "SCENE 2",
            "media": [
                "https://cdn.searchenginejournal.com/wp-content/uploads/2018/04/durable-urls.png"
            ],
            "texts": [
                "this is the second scenes title"
            ],
            "transcript": "this is the second scenes transcript"
        },
        {
            "name": "SCENE 3",
            "texts": [
                "this is the third scenes title"
            ],
            "transcript": "this is the third scenes transcript"
        }
    ]
}

Get the video status

Using the id received in the video creation call you will be able to poll the status of your video by calling the following API

You can always go to the Reals platform and see your videos and status there.

Get Videos

get

Get videos

Authorizations

Responses

200

Successful Response

application/json

get

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

Path parameters

video_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

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

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.

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

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