Help Center> Media Processing Center> API Reference> API Overview
View PDF

API Overview

The following tables list the MPC APIs. Before calling an MPC API, you need to obtain a user token. The obtained token can then be used to authenticate the calling of other APIs. For details about how to call an MPC API, see Getting Started.

Custom Transcoding Templates

A transcoding template is used to define transcoded video information. Before transcoding a video, you need to create a transcoding template.

API

Description

POST /v1/{project_id}/template/transcodings

Creating a Transcoding Template

DELETE /v1/{project_id}/template/transcodings{?temp_id}

Deleting a Transcoding Template

PUT /v1/{project_id}/template/transcodings

Modifying a Transcoding Template

GET /v1/{project_id}/template/transcodings{?temp_id}

Querying Transcoding Templates

Custom Transcoding Template Groups

A transcoding template group defines the output file information. A custom template group can contain a maximum of six output configurations.

API

Description

POST /v1/{project_id}/template_group/transcodings

Creating a Transcoding Template Group

PUT /v1/{project_id}/template_group/transcodings{?temp_id}

Modifying a Transcoding Template Group

DELETE /v1/{project_id}/template_group/transcodings

Deleting a Transcoding Template Group

GET /v1/{project_id}/template_group/transcodings{?temp_id}

Querying Transcoding Template Groups

Watermarking

Call the watermark template APIs to deliver the watermark template and add watermarks to videos during transcoding.

API

Description

POST /v1/{project_id}/template/watermark

Creating a Watermark Template

PUT /v1/{project_id}/template/watermark

Modifying a Watermark Template

GET /v1/{project_id}/template/watermark{?template_id,page,size}

Querying Watermark Templates

DELETE /v1/{project_id}/template/watermark{?template_id}

Deleting a Watermark Template

Media Transcoding

API

Description

POST /v1/{project_id}/transcodings

Creating a Transcoding Task

DELETE /v1/{project_id}/transcodings{?task_id}

Canceling a Transcoding Task

GET /v1/{project_id}/transcodings{?task_id,start_time,end_time,status,page,size}

Querying Transcoding Tasks

Packaging

API

Description

POST /v1/{project_id}/remux

Creating a Packaging Task

DELETE /v1/{project_id}/remux{?task_id}

Canceling a Packaging Task

GET /v1/{project_id}/remux{?task_id,start_time,end_time,status,page,size}

Querying Packaging Tasks

PUT /v1/{project_id}/remux

Retrying a Packaging Task

GIF Converting

API

Description

POST /v1/{project_id}/animated-graphics

Creating an Animated GIF Task

DELETE /v1/{project_id}/animated-graphics{?task_id}

Canceling an Animated GIF Task

GET /v1/{project_id}/animated-graphics{?task_id,start_time,end_time,status,page,size}

Querying Animated GIF Tasks

Video Parsing

API

Description

POST /v1/{project_id}/extract-metadata

Creating a Video Parsing Task

DELETE /v1/{project_id}/extract-metadata{?task_id}

Canceling a Video Parsing Task

GET /v1/{project_id}/template/extract-metadata{?task_id,start_time,end_time,status,page,size}

Querying Video Parsing Tasks

Snapshot Capturing

API

Description

POST /v1/{project_id}/thumbnails

Creating a Snapshot Task

DELETE /v1/{project_id}/thumbnails{?task_id}

Canceling a Snapshot Task

GET /v1/{project_id}/thumbnails{?task_id,start_time,end_time,status,page,size}

Querying Snapshot Tasks

Encryption

API

Description

POST /v1/{project_id}/encryptions

Creating an Encryption Task

DELETE /v1/{project_id}/encryptions/?task_id={task_id}

Canceling an Encryption Task

GET /v1/{project_id}/encryptions{?task_id,start_time,end_time,status,page,size}

Querying Encryption Tasks