POST
/
clip
/
{clip_id}
/
render_video
curl --request POST \
  --url https://api.video.dev/v1/clip/{clip_id}/render_video \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "crop": {
    "enabled": false,
    "aspect_ratio": "16:9",
    "smart_crop": false
  },
  "webhook": {
    "url": "https://system.new/webhook/v1",
    "events": [
      "complete"
    ]
  }
}'
{
  "crop": {
    "enabled": false,
    "aspect_ratio": "16:9",
    "smart_crop": false
  },
  "status": "processing",
  "render_id": "<string>",
  "source_clip": {
    "start_time_ms": 123,
    "end_time_ms": 123,
    "clip_id": "<string>",
    "duration_ms": 123,
    "source_media": {
      "status": "complete",
      "media_id": "<string>",
      "media_url": "https://storage.xyz/media.mp4",
      "media_info": {
        "type": "video",
        "duration_ms": 123,
        "fps": 123,
        "frame_count": 123,
        "width": 123,
        "height": 123,
        "channels": 123
      }
    }
  },
  "rendered_media": {
    "status": "processing",
    "media_id": "<string>"
  },
  "webhook": {
    "url": "https://system.new/webhook/v1",
    "events": [
      "complete"
    ]
  }
}

​
Webhooks

Webhooks allow video.dev to notify your API when results are ready. This eliminates unnecessary requests made by polling, and can get results back faster.

Webhooks can be registered as part of the request and various events can be subscribed to get status of .

The following is a full list of all webhook events which can be subscribed.

EventDescription
completeOccurs when a new clips are available
errorOccurs when auto clip creation has errors

The webhook will be POST to the URL you provided with a JSON payload. The payload will contain the event type and the details associated with the event.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
crop
object
​
webhook
object

Callback to listen for events

Response

200
application/json
Render Clip initiated successfully
​
status
enum<string>
required
Available options:
complete,
processing,
error
Example:

"processing"

​
render_id
string
required

Reference id to check render status

​
source_clip
object
required

Source clip to render

​
rendered_media
object
required

Rendered media info

​
crop
object
​
webhook
object

Callback to listen for events

Was this page helpful?