API reference

Reserve an upload

First of the three calls that upload a video. Returns an upload_path to send the bytes to, and the video_id you will reference from an evaluation.

The whole sequence:

POST /v1/videos with the file’s content type and size. You get back a video_id and a short-lived upload_path.
PUT the raw bytes to upload_path. Send no Authorization header on this request — upload_path is on separate storage infrastructure, not this API, and a key sent there is a key disclosed to a third party. Declare Content-Length; a request that does not is refused. The grant expires after 15 minutes, and a replacement means starting again at step 1.
POST /v1/videos/{video_id}/complete, which hands the file to validation. Poll GET /v1/videos/{video_id} until status is ready; only then may an evaluation reference it.

Pass content_hash (SHA-256 of the bytes, hex) to skip the transfer when we already hold that exact content: the response then carries skip_upload: true and no upload_path, and the video is immediately usable. Nothing is charged for the bytes you did not send.

This consumes an upload quota slot. A rejected content type or an oversized size_bytes is refused before the slot is taken.

POST

videos

Reserve an upload

curl --request POST \
  --url https://api.physionlabs.ai/v1/videos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content_type": "video/mp4",
  "size_bytes": 26214400,
  "content_hash": "<string>",
  "duration_sec": 123,
  "width": 2,
  "height": 2
}
'

import requests

url = "https://api.physionlabs.ai/v1/videos"

payload = {
    "content_type": "video/mp4",
    "size_bytes": 26214400,
    "content_hash": "<string>",
    "duration_sec": 123,
    "width": 2,
    "height": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    content_type: 'video/mp4',
    size_bytes: 26214400,
    content_hash: '<string>',
    duration_sec: 123,
    width: 2,
    height: 2
  })
};

fetch('https://api.physionlabs.ai/v1/videos', 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.physionlabs.ai/v1/videos",
  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([
    'content_type' => 'video/mp4',
    'size_bytes' => 26214400,
    'content_hash' => '<string>',
    'duration_sec' => 123,
    'width' => 2,
    'height' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.physionlabs.ai/v1/videos"

	payload := strings.NewReader("{\n  \"content_type\": \"video/mp4\",\n  \"size_bytes\": 26214400,\n  \"content_hash\": \"<string>\",\n  \"duration_sec\": 123,\n  \"width\": 2,\n  \"height\": 2\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.physionlabs.ai/v1/videos")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content_type\": \"video/mp4\",\n  \"size_bytes\": 26214400,\n  \"content_hash\": \"<string>\",\n  \"duration_sec\": 123,\n  \"width\": 2,\n  \"height\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.physionlabs.ai/v1/videos")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content_type\": \"video/mp4\",\n  \"size_bytes\": 26214400,\n  \"content_hash\": \"<string>\",\n  \"duration_sec\": 123,\n  \"width\": 2,\n  \"height\": 2\n}"

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

{
  "video_id": "<string>",
  "cdn_url": "<string>",
  "upload_path": "<string>",
  "skip_upload": true
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

Authorizations

Authorization

string

header

required

Use a key created in the Playground. Keys begin with gk_.

Body

application/json

content_type

enum<string>

required

Only MP4 is accepted.

Available options:

video/mp4

size_bytes

integer

required

Exact size of the file you are about to send. It is signed into the grant, so the storage endpoint refuses a body that exceeds it -- an understated size fails the PUT rather than the reservation.

Required range: 1 <= x <= 52428800

content_hash

string

SHA-256 of the bytes, hex. Optional, and worth sending: when we already hold this exact content the response says skip_upload and there is nothing to transfer.

Pattern: ^[0-9a-f]{64}$

duration_sec

number

Optional metadata recorded on the video.

width

integer

Optional metadata recorded on the video.

Required range: x >= 1

height

integer

Optional metadata recorded on the video.

Required range: x >= 1

Response

Upload reserved, or an existing copy matched.

video_id

string

required

Reference this as the evaluation's video.upload_id, once the video reaches ready.

cdn_url

string<uri>

required

Where the bytes will be readable once the upload completes.

upload_path

string

Where to PUT the bytes. A path or absolute URL on separate storage infrastructure, valid for 15 minutes, carrying its own signed grant -- send no Authorization header with it. Absent when skip_upload is true.

skip_upload

boolean

Present and true when content_hash matched content we already hold. Skip straight to referencing video_id: there is nothing to upload and no completion call to make.

⌘I

Reserve an upload

curl --request POST \
  --url https://api.physionlabs.ai/v1/videos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content_type": "video/mp4",
  "size_bytes": 26214400,
  "content_hash": "<string>",
  "duration_sec": 123,
  "width": 2,
  "height": 2
}
'

import requests

url = "https://api.physionlabs.ai/v1/videos"

payload = {
    "content_type": "video/mp4",
    "size_bytes": 26214400,
    "content_hash": "<string>",
    "duration_sec": 123,
    "width": 2,
    "height": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    content_type: 'video/mp4',
    size_bytes: 26214400,
    content_hash: '<string>',
    duration_sec: 123,
    width: 2,
    height: 2
  })
};

fetch('https://api.physionlabs.ai/v1/videos', 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.physionlabs.ai/v1/videos",
  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([
    'content_type' => 'video/mp4',
    'size_bytes' => 26214400,
    'content_hash' => '<string>',
    'duration_sec' => 123,
    'width' => 2,
    'height' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.physionlabs.ai/v1/videos"

	payload := strings.NewReader("{\n  \"content_type\": \"video/mp4\",\n  \"size_bytes\": 26214400,\n  \"content_hash\": \"<string>\",\n  \"duration_sec\": 123,\n  \"width\": 2,\n  \"height\": 2\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.physionlabs.ai/v1/videos")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content_type\": \"video/mp4\",\n  \"size_bytes\": 26214400,\n  \"content_hash\": \"<string>\",\n  \"duration_sec\": 123,\n  \"width\": 2,\n  \"height\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.physionlabs.ai/v1/videos")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content_type\": \"video/mp4\",\n  \"size_bytes\": 26214400,\n  \"content_hash\": \"<string>\",\n  \"duration_sec\": 123,\n  \"width\": 2,\n  \"height\": 2\n}"

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

{
  "video_id": "<string>",
  "cdn_url": "<string>",
  "upload_path": "<string>",
  "skip_upload": true
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_body",
    "message": "<string>",
    "request_id": "<string>"
  },
  "quota": {
    "limit": 1,
    "used": 1,
    "remaining": 1,
    "reset_at": 1,
    "reset_in_sec": 1,
    "window_sec": 2,
    "unlimited": true
  }
}

Getting started

Guides

SDKs

API reference

Resources

Reserve an upload

Authorizations

Body

Response