Video Generation

---

• Example Call

To generate a video with the Placid REST API:

1. Create an API project or add the API integration to your project in Placid
2. Create and design your template(s)
3. Send your data and customizations to the API
4. Poll the GET endpoint for status updates or use a webhook to get the generated video

{info} Every 10 seconds = 10 credits

Switch to test mode for free watermarked previews!

Example Call

// - POST to endpoint `https://api.placid.app/api/rest/videos`

{
    ...

    "clips": [
        {
            "template_uuid": "illcmemnt",
            "layers": {
                "video": {
                    "video": "https://socialmediacollection.com/assets/video-tiktok-1.mp4"
                },
                "logo": {
                    "image": "https://socialmediacollection.com/assets/logo.png"
                },
                "username": {
                    "text": "@username"
                }
            },
        },
    ],

    ...

    // Options for filename, size modifications, export,..
}

The video object

Properties

{
    "id": 1,
    "status": "queued",
    "video_url": null,
    "polling_url": null
}

Create a Video

Create a new video by using the following endpoint and request structure. Videos are generated from one or more templates used as clips, filling their layers with your data.

Endpoint

{
  "webhook_success": "https://webhook.url",
  "passthrough": null,

  "clips": [
    {
        "template_uuid": "<template_uuid>",

        // - audio settings
        "audio" : "https://mp3url.mp3",
        "audio_duration" : "...", 
        "audio_trim_start" : "00:00:00", 
        "audio_trim_end" : "00:00:00",

        // - layer settings
        "layers": {
            "video": {
                "video": "https://videourl.mp4"
            },
            "img": {
                "image": "https://imageurl.jpg"
            },
            "subtitle": {
                "hide": true
            },
            "title": {
                "text": "Lorem Ipsum"
            }
            ...
        },
    },
    // ...
  ],

  "modifications": {
     "width": "<width>",
     "height": "<height>",
     "fps": "<fps>",
     "filename": "<filename>",
     "canvas_background": "blur"
  },
  "transfer": {
     "to": "s3",
     "key": "<your key>",
     "secret": "<your secret>",
     "region": "<region name>",
     "bucket": "<bucket name>",
     "visibility": "public",
     "path": "videos/video.mp4",
     "endpoint": "https://exampleendpoint.com"
  }
}

Video content

The content of your video will be defined by an array of templates in your clips object.

Get your {template_uuid} from the template overview in the Templates tab of your Placid API project.

• The API allows you to create a video from one or more clips / templates, merged in the order you define
• You can fill one or more picture layers in your template with video files
• You can fill one or more values into text layers of your template
• Use animation and transition settings in the template editor
• Total clip length will be dependent on your dynamic content
• If you fill a clip with > 1 video, the shorter videos will loop automatically until the longest is finished
• Audio tracks are taken from your source video(s)
• Current max video length is 3 minutes (= 180 seconds)
• If you do not define any width and height modifications, the video will be sized according to your first clip template's size
• Differently sized clips will be set on a canvas background customizable via modifications below
• ➡️ Learn more about Placid video settings, clip length and behaviour

Export / transfer

To transfer the generated video to your storage use the transfer object.

File modifications

To modify the generated video use the modifications object.

Retrieve a Video

This endpoint allows you to retrieve a video by providing their unique id. Refer to the object at the top of this page to see which properties are included with video objects.

Endpoint

Delete a Video

This endpoint allows you to delete a video by providing its unique id. Once deleted, the video cannot be retrieved or used.

Endpoint

Response

• Success: On successful deletion, the API will return a 204 No Content status code.
• Not Found: If the video with the specified id does not exist, the API will return a 404 Not Found error.

---