Audio Extractor from Video Job API - ApyHub

Audio Extractor from Video Job API

File Manipulation#aac#ac3#amr#audio#flac#job#mp3#ogg#video#wav#wma
job
ApyHub
ApyHub
verified icon
400 atoms

About

The Audio Extractor from Video Job API is a powerful audio extraction tool that makes audio extraction simple, scalable, and automated. Submit a job with your video source and choose from popular audio formats like MP3, WAV, AAC, OGG, or FLAC. The system processes the extraction in the background, letting you continue working while the audio is prepared.
This job-based API reduces manual steps for content creators and developers. It streamlines the extraction process, helping you stay organized and efficient, especially when handling multiple or large video files.
Try the Audio Extraction Job API in the API playground for quick, hassle-free, and automated audio extraction at scale.
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

Extract Audio from Video Submit Job : input file
POST
https://api.apyhub.com/job/extract/video/audio/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/job/extract/video/audio/file' \
2
--header 'apy-token: {{token}}' \
3
--form 'video=@"sample.mp4"' 
4
--form 'start_time="0"'
5
--form 'duration="5"'
6
--form 'output_format="mp3"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
persistentBooleanNoSet to true to retain the converted 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).
start_timeStringNothe time in seconds from which you want to extract the audio. For instance, if a video is 3 minutes long and you intend to extract audio starting from the 90th second, set start_time: 90. The default is 0, extracting audio from the beginning of the video.
durationStringNothe length of the audio to be extracted. For instance, if you want to extract a 4 second audio clip, set duration: 4. The default is 2 seconds. Note: This parameter is ignored when full_audio is set to true.
output_formatStringNothe output format of the extracted audio file, user can enter any of mp3,wav,aac,ogg,flac,wma,ac3,amr. The default is mp3 audio format.
full_audioBooleanNowhen set to true, extracts the complete audio from the video starting from start_time (or from the beginning if no start_time is specified). When false or not provided, uses the duration parameter to extract a specific segment. Default is false.
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 extracted audio.
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