Create an appraisal using a configuration ID

post

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

Creates an appraisal for processing a video with options specified in the query parameters and a predefined configuration identified by confId.

The processed video will be associated with the same team and project as the specified videoId once accepted. Appraisals have an expiry time and must be accepted before the processing task can start.

Path Params

videoId

uuid

required

The unique identifier for the video.

confId

uuid

required

The unique identifier for the video processing configuration.

Query Params

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

Loading…

Response

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

application/json

*/*

201Successfully retrieved video processing appraisal details.

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.