Upload media file or URL

curl --request POST \
  --url https://api.viddyscribe.com/enterprise/api/upload_media \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "input": {
    "type": "url",
    "url": "<string>",
    "filename": "<string>"
  }
}
'

import requests

url = "https://api.viddyscribe.com/enterprise/api/upload_media"

payload = { "input": {
        "type": "url",
        "url": "<string>",
        "filename": "<string>"
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({input: {type: 'url', url: '<string>', filename: '<string>'}})
};

fetch('https://api.viddyscribe.com/enterprise/api/upload_media', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.viddyscribe.com/enterprise/api/upload_media",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => [
        'type' => 'url',
        'url' => '<string>',
        'filename' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.viddyscribe.com/enterprise/api/upload_media"

	payload := strings.NewReader("{\n  \"input\": {\n    \"type\": \"url\",\n    \"url\": \"<string>\",\n    \"filename\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.viddyscribe.com/enterprise/api/upload_media")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": {\n    \"type\": \"url\",\n    \"url\": \"<string>\",\n    \"filename\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.viddyscribe.com/enterprise/api/upload_media")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": {\n    \"type\": \"url\",\n    \"url\": \"<string>\",\n    \"filename\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "media_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "created",
  "duration_seconds": 45.5,
  "frame_rate": 30
}

POST

enterprise

api

upload_media

Upload media file or URL

curl --request POST \
  --url https://api.viddyscribe.com/enterprise/api/upload_media \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "input": {
    "type": "url",
    "url": "<string>",
    "filename": "<string>"
  }
}
'

import requests

url = "https://api.viddyscribe.com/enterprise/api/upload_media"

payload = { "input": {
        "type": "url",
        "url": "<string>",
        "filename": "<string>"
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({input: {type: 'url', url: '<string>', filename: '<string>'}})
};

fetch('https://api.viddyscribe.com/enterprise/api/upload_media', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.viddyscribe.com/enterprise/api/upload_media",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => [
        'type' => 'url',
        'url' => '<string>',
        'filename' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.viddyscribe.com/enterprise/api/upload_media"

	payload := strings.NewReader("{\n  \"input\": {\n    \"type\": \"url\",\n    \"url\": \"<string>\",\n    \"filename\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.viddyscribe.com/enterprise/api/upload_media")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": {\n    \"type\": \"url\",\n    \"url\": \"<string>\",\n    \"filename\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.viddyscribe.com/enterprise/api/upload_media")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": {\n    \"type\": \"url\",\n    \"url\": \"<string>\",\n    \"filename\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "media_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "created",
  "duration_seconds": 45.5,
  "frame_rate": 30
}

Usage Examples

1. Upload from URL

Ingest a video from a public URL.

curl -X POST https://api.viddyscribe.com/enterprise/api/upload_media \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "type": "url",
      "url": "https://example.com/video.mp4"
    }
  }'

2. Upload Local File

Upload a video file directly. For local files up to 32 MB, multipart upload is supported directly. For larger local files, see Large Local File Upload.

curl -X POST https://api.viddyscribe.com/enterprise/api/upload_media \
  -H "X-API-Key: YOUR_API_KEY" \
  -F 'input={"type": "file"}' \
  -F "file=@/path/to/video.mp4"

3. Request a Signed Upload URL

For larger local files, request a signed upload URL first.

curl -X POST https://api.viddyscribe.com/enterprise/api/upload_media \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "type": "signed_url",
      "filename": "video.mp4",
      "content_type": "video/mp4"
    }
  }'

Then upload the file to upload_url, call notify_upload_complete, and poll get_upload_status until the upload is ready before generating with media_id. See Large Local File Upload for the full workflow.

Common Upload Errors

Error	HTTP Status	Description
`no_video_stream`	`415`	The uploaded file is not a valid video stream for processing. This usually means the file contains audio only.
`video_too_long`	`403`	The uploaded video exceeds the maximum duration allowed by the current plan.
`file_too_large`	`403`	The uploaded file exceeds the maximum file size allowed by the current plan.

Example response:

{
  "error": "no_video_stream",
  "message": "The uploaded file contains audio only. Please upload a video file with at least one video stream."
}

Authorizations

X-API-Key

string

header

required

API key for authentication. Obtain from your team admin.

Example: X-API-Key: vsk_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz

Body

input

Upload from URL · object

required

Upload from URL
Request Signed Upload URL

Show child attributes

Response

Media uploaded successfully

media_id

string<uuid>

Unique identifier for the uploaded media

status

enum<string>

Upload status

Available options:

created,

existing,

pending_upload

duration_seconds

number | null

Video duration in seconds

frame_rate

number | null

Video frame rate (fps)

upload_url

string<uri> | null

Signed PUT URL returned for signed_url uploads

gcs_path

string | null

Storage path associated with the uploaded media

content_type

string | null

Content-Type associated with a signed upload

API Reference

Media

Text Generation

Audio Generation

Video Generation

Results

Upload media file or URL

Usage Examples

1. Upload from URL

2. Upload Local File

3. Request a Signed Upload URL

Common Upload Errors

Authorizations

Body

Response

​Usage Examples

​1. Upload from URL

​2. Upload Local File

​3. Request a Signed Upload URL

​Common Upload Errors

Authorizations

Body

Response

Usage Examples

1. Upload from URL

2. Upload Local File

3. Request a Signed Upload URL

Common Upload Errors