{
"status": "IN_QUEUE",
"request_id": "01a04482-39ff-7632-b67a-97d87c97ffdb",
"response_url": "-01a04482-39ff-7632-b67a-97d87c97ffdb",
"status_url": "-01a04482-39ff-7632-b67a-97d87c97ffdb/status",
"cancel_url": "-01a04482-39ff-7632-b67a-97d87c97ffdb/cancel",
"logs": null,
"metrics": [],
"queue_position": 0
}
curl --location --request POST 'https://zylalabs.com/api/13644/waveform+api/30943/get+id' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"media_url": "https://storage.googleapis.com/falserverless/example_inputs/ffmpeg-audio.wav",
"points_per_second": 4,
"precision": 2,
"smoothing_window": 3
}'
{
"waveform": [
-0.14,
-0.46,
-0.67,
-0.25,
-0.42,
-0.17,
-0.52,
-1,
-0.4,
-0.13,
-0.36,
-0.52,
-0.36,
-0.13,
-0.2,
-0.52,
-0.45,
-0.31,
-0.13,
-0.06,
0.07
],
"duration": 5.36,
"points": 21,
"precision": 2
}
curl --location --request GET 'https://zylalabs.com/api/13644/waveform+api/30944/create+waveform&request_id=Required' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Waveform API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
The Waveform API generates a numerical representation of an audio waveform from a provided media URL. Simply submit a publicly accessible URL containing an audio or video file, and the API analyzes the audio track and returns a structured waveform that can be used for visualizations, playback interfaces, audio analysis, and multimedia applications.
The response includes a waveform array containing normalized amplitude values that represent the audio signal over the analyzed duration. These values can be used to generate waveform visualizations, such as timelines, audio players, progress bars, editing interfaces, and interactive multimedia components. Positive and negative values represent the amplitude of the audio signal, while the number of points returned determines the level of detail available for visualization.
The API also returns the total duration of the analyzed multimedia content in seconds, allowing applications to synchronize the waveform with playback. The “points” field indicates the number of waveform samples returned, while “precision” specifies the decimal precision used for the waveform values.
The POST Get ID endpoint returns a request ID and status information about the waveform generation process. The GET Create Waveform endpoint returns a structured waveform array, duration of the audio, number of points, and precision of the waveform values.
Key fields in the POST Get ID response include `request_id`, `status`, and `queue_position`. In the GET Create Waveform response, important fields are `waveform`, `duration`, `points`, and `precision`, which provide essential details for audio visualization.
The response data is organized in JSON format. The POST Get ID response includes status and request information, while the GET Create Waveform response contains an array of waveform values, along with metadata like duration and precision, making it easy to parse and utilize.
The POST Get ID endpoint does not require parameters. The GET Create Waveform endpoint accepts a media URL, which must be publicly accessible. Users can customize their requests by specifying the URL of the audio or video file they wish to analyze.
Typical use cases include generating visual representations of audio for music players, creating interactive multimedia components, and conducting audio analysis for research or development purposes. The waveform data can enhance user interfaces and improve audio-related applications.
Users can visualize the waveform data by mapping the amplitude values to graphical representations, such as waveforms or progress bars. The duration and precision fields help synchronize visualizations with audio playback, enhancing user experience in multimedia applications.
Data accuracy is maintained through robust processing algorithms that analyze audio tracks from the provided media URLs. The API ensures that the waveform points accurately reflect the audio signal's amplitude, allowing for reliable visualizations and analyses.
Users can expect normalized amplitude values in the waveform array, typically ranging from -1 to 1. The number of points returned will vary based on the audio's duration and complexity, providing a detailed representation suitable for various visualization needs.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund