API ReferenceChangelog
Log In
API Reference

Copy video data from an HTTPS URL into the Pixop Platform

Copies video data from an HTTPS URL into the Pixop Platform, making it available for processing.

A new master video record is created for the selected team, and an asynchronous multipart copy operation from the provided HTTPS URL to Pixop is initiated.
The URL must support range requests and remain accessible for the entire duration of the copy process.

The status of the copy operation can be tracked using:

The videoId is returned in the response.

Workflow:

  1. Copy Operation: Once complete, the status updates to DONE.
  2. Ingestion Process: If FullIngestion is true, Pixop extracts thumbnails, full frames, and a web video.
  3. Free 10-Second Clip: Unless disabled for the team, a free 10-second clip is automatically created and becomes available via GET /v1/videos/{videoId}/derived.
    This clip is treated as a separate video and will trigger its own clip_processing and clip_ingestion webhook events under a new videoId.

Notes:

  • If the video size exceeds 500 GB, a 400 Bad Request response is returned.
  • A 400 Bad Request may also be returned if the URL is invalid, inaccessible, or does not support range requests.
Query Params
boolean
Defaults to false

Determines the ingestion level:

  • false: Only metadata is ingested. Thumbnails, web video artifacts, quality assessments, and deep scanning type analysis are not performed. This mode is suitable for third-party integrations that process videos in an ephemeral manner.
  • true: Full ingestion is performed, including metadata, thumbnails, web video artifacts, quality assessments, and deep scanning analysis. This mode is used for videos that need to be available on the web application.
uuid

Specifies the team ID for the operation.

  • For POST requests, assigns the new object to the specified team.
  • For GET requests, retrieves data for the specified team. If not provided, defaults to the ID of the default team associated with the API key.
int64
0 to 4294967295

Optional CRC32C checksum of the video file, used for data integrity verification.

integer
1 to 20
Defaults to 10

The maximum number of concurrent connections allowed for this import.

Body Params

Parameters required for importing a video from an HTTPS URL into the Pixop Platform.

Represents the fields that can be updated for a video resource.

string
required
length between 1 and 255

The name of the video. Used to easily identify specific videos within projects. The name must be between 1 and 255 characters long.

string
length between 0 and 511

Optional description of the video. The description must be between 0 and 511 characters long.

uuid

The ID of the project to which the video belongs. If not specified, the video is added to the default project.

string
length between 1 and 255

The name of the video file, such as myvideo.mp4. If not specified, a normalized version of name will be used.

string
required
length between 1 and 4096

A URL that must use HTTPS and point to a publicly reachable address. Only port 443 is allowed for HTTPS URLs. The following addresses are not allowed:

  • Loopback (e.g., 127.x.x.x, ::1)
  • Site-local (RFC1918) addresses (e.g., 10.x.x.x, 192.168.x.x, 172.16–31.x.x, IPv6 unique-local)
  • Link-local addresses (e.g., 169.254.x.x, fe80::/10)
  • Multicast addresses (e.g., 224.0.0.0–239.255.255.255, ff00::/8)

The server will parse the URL, resolve its host, and reject any internal or non-public address.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json