Copy video data from an S3 bucket into the Pixop Platform

post

https://api.pixop.com/api/v1/videos/in/s3

Copies video data from an S3 bucket 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 S3 bucket to Pixop is initiated.

The status of the copy operation can be tracked using:

GET /v1/videos/{videoId}/in/status
GET /v1/videos/{videoId} (for full video details)
Webhooks: Subscribe to video_in and/or video_in_ingestion events to receive real-time updates

The videoId is returned in the response.

Workflow:

Copy Operation: Once complete, the status updates to DONE.
Ingestion Process: If FullIngestion is true, Pixop extracts thumbnails, full frames, and a web video.
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.

Note:

If the video size exceeds 500 GB, a 400 Bad Request response is returned.
A 400 Bad Request may also be returned for other reasons, such as invalid credentials.
A 404 Not Found response is returned if the bucket, or object does not exist.

Query Params

fullIngestion

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.

selectTeamId

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.

Body Params

Parameters required for importing a video from a specified S3 bucket into the Pixop Platform.

name

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.

description

string

length between 0 and 511

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

projectId

uuid

A universally unique identifier (UUID) compliant with RFC 4122. Used as a unique key to identify resources or entities across systems.

fileName

string

length between 1 and 255

The name of the file, including its extension. E.g., myvideo.mp4.

objectKey

string

required

length between 1 and 1024

The object key of a video in an S3 bucket. For example, src/myvideo.mp4.

s3Bucket

object

required

Represents the fields that can be updated for an S3 bucket with access keys.

Responses

202Successfully retrieved the status of a master video upload and ingestion.

400Invalid request. Inspect the details of the error for more information.

401Authentication failed. Missing or invalid X-API-Key or basic authentication credentials.

403Access denied. You do not have the necessary permissions to access this resource.

404The requested resource could not be found.

429Too Many Requests. The rate limit for this resource has been exceeded.

500An unexpected error occurred on the server.