Skip to main content
POST
/
upload
curl --request POST \
  --url https://app.nivo.video/api/v1/upload \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/video.mp4",
  "collection_id": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Sample Video",
  "description": "A sample video for processing"
}
'
{
  "uploadRequestId": "550e8400-e29b-41d4-a716-446655440000"
}
Creates a new upload request to process a media file from a URL. The file will be processed asynchronously.

Authorizations

​
Authorization
string
header
required

API key for authentication. Include your company's API key in the Authorization header.

Body

application/json
​
url
string<uri>
required

URL of the media file to be processed. Must be a valid HTTP/HTTPS URL.

Example:

"https://example.com/video.mp4"

​
collection_id
string<uuid>
required

UUID of the collection where the processed file will be stored.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
folder_id
string<uuid> | null

Optional UUID of the folder within the collection.

Example:

"987fcdeb-51a2-43d7-8f9e-123456789abc"

​
title
string | null

Optional title for the upload.

Example:

"Sample Video Title"

​
description
string | null

Optional description for the upload.

Example:

"This is a sample video for processing"

​
tags
string[] | null

Optional array of tags to categorize the upload.

Example:
["video", "presentation", "2024"]
​
metadata
object

Optional key-value pairs for additional metadata.

Example:
{
  "department": "marketing",
  "project": "Q4-campaign"
}

Response

Upload request created successfully

​
uploadRequestId
string<uuid>
required

Unique identifier for the created upload request.

Example:

"550e8400-e29b-41d4-a716-446655440000"