Appearance
Pipelines Resource
Description
The /pipelines endpoint allows for configuring input/output storage options for a media processing service, including where to fetch input files and where to upload them after processing.
A Pipeline combines two things: an internal storage "folder" (the input/output queue that feeds the transcoder service) and the processing pipeline (the transcoder module that converts your videos). Every pipeline corresponds to a root folder entry in the Files resource, and files can be uploaded/downloaded relative to it (see the Files resource).
Some behavioral notes:
- Jobs are processed in a single, best-effort queue ("default") — currently, there is just one type of queue and no special service-level guarantees.
- Converted output files created by a job are persisted on the pipeline's store until they are explicitly deleted (either by deleting the job or the individual files).
- Input files that a job downloaded from remote locations (via an external
input_download_diror a direct URL in the job'sinput.input_name) are not persisted after the job finished — they are pruned upon successful job completion. - Output files that are uploaded to a remote location (via
output_upload_dir) are also persisted on the pipeline's store — so they remain available for MediaHub CDN distribution — until the job or the files are explicitly deleted. - Files uploaded to a pipeline via the Uploads API are temporary by default and pruned after seven days. Their persistence is controlled by the upload's
expires_atparameter: a custom value sets a custom expiry, and0keeps the file until it is explicitly deleted. - Notifications ("pings") can be configured to be sent across the various stages of a transcoding job (see
ping_urls).
Supported Methods
- POST: Create a new pipeline.
- GET: List all pipelines or get information about a specific pipeline.
- PUT: Update an existing pipeline.
- DELETE: Delete a pipeline.
POST /pipelines
Create a new pipeline. Read More
GET /pipelines
List all pipelines. Read More
GET /pipelines/
Get information about a specific pipeline. Read More
PUT /pipelines/
Update a specific pipeline. Read More
DELETE /pipelines/
Delete a pipeline. Read More