Compress Video Job API - ApyHub

Compress Video Job API

File Manipulation#compress#job#video
job
ApyHub
ApyHub
verified icon
400 atoms
Premium tier

About

The video compression Job API enables you to compress video files through an asynchronous workflow, making it ideal for handling large-scale or long-duration tasks.
With this API, you can submit video files, video URLs, or links from platforms like YouTube and Dailymotion, and the system processes them in the background. This eliminates the need to wait for real-time compression, allowing you to focus on other tasks while the API handles the workload.
Content creators and businesses can benefit from this improved efficiency, especially when managing multiple or high-resolution videos. It reduces file sizes for faster uploads and seamless sharing while optimizing storage management and bandwidth use for video platforms.
Try the Compress Video API in the API playground and see how the Job API simplifies large-scale video compression.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Video Compression Submit Job : input file
POST
https://api.apyhub.com/job/compress/video/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/job/compress/video/file' \
2
--header 'apy-token: {{token}}' \
3
--form 'video=@"sample.mp4"' 
4
--form 'compression_percentage="50"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
persistentBooleanNoSet to true to retain the compressed video URL indefinitely. If false, the URL expires after 15 minutes, default false.
Request Body
AttributeTypeMandatoryDescription
videoFileYesThe source video file in any of supported formats (mp4,webm,flv,avi,mkv,mov,3gp).
compression_percentageNumberNoThe compression percentage to be applied to the video must be in a numeric format, with a valid range between 0 and 100. By default, it is set to 50.
Response
AttributeTypeDescription
job_idStringThe ID of the Job associated with the input video file, which can be utilized by the "Check Status" endpoint to retrieve the compressed video.
Sample Response
1
{
2
    "job_id": "4f3dfb22-33df-49f6-9820-7d8219ab6dc4"
3
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the provided files are corrupt or the supported inputs are not provided.
500If any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles