Start video processing using a configuration ID

post

https://api.pixop.com/api/v1/videos/{videoId}/processing/start/{confId}

Initiates the processing of the specified video with options specified in the query parameters and a predefined configuration identified by confId.

A new video, identified by the videoId returned in the response, is created. This videoId should be used to track the asynchronous processing operation using:

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

Path Params

videoId

uuid

required

The unique identifier for the video.

confId

uuid

required

The unique identifier for the video processing configuration.

Query Params

videoName

string

length between 1 and 255

Specifies the name of the video. If not provided, the name will be derived from the source video.

videoDescription

string

length between 0 and 511

Optional description for the video.

startPosMs

int32

≥ 0

Specifies the start position of the source video for processing, in milliseconds. Defaults to the start of the source video. Providing a value greater than (source video duration or EndPositionMillisecondsParam) - 1000 results in a 400 Bad Request response.

endPosMs

int32

≥ 1000

Specifies the end position of the source video for processing, in milliseconds. Defaults to the end of the source video.

If the specified value exceeds the source video duration, it will be adjusted to match the end of the source video.
Providing a value smaller than (StartPositionMillisecondsParam + 1000) results in a 400 Bad Request response.

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

202Successfully retrieved the status of video processing.

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.

409Conflict detected. The request could not be processed due to conflicting data.

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

500An unexpected error occurred on the server.