Waveform Data API

Reduces an audio file to a fixed number of normalised waveform peaks for drawing, without shipping samples.

Updated

Agents read this page asGET /v1/waveform-data/schemafree: schema, examples, errors, price

Endpoint
POST /v1/waveform-data
Price
$0.003 per call
Timeout
90 s
max_timeout_seconds
111 (the whole call as the 402 envelope sells it: the timeout, plus payment verification and settlement around it)
Response cap
100 MB (104,857,600 bytes)

When to use it

Decoding audio to peaks needs ffmpeg AND a hardened fetch: an agent that pulls the URL itself walks past every SSRF control, and carrying an ffmpeg per call is not something an agent does inline.

When not to use it

  • The input is over 100 MB (104,857,600 bytes): waveform-data answers too_large (413).
  • The destination needs more than 90 s to answer: the call ends with upstream_timeout (424).
  • The destination is on a private or local network: the network guard refuses it with blocked_target (403).

Parameters

One JSON body. The schema is free at GET /v1/waveform-data/schema.

FieldTypeRequiredDescription
urlstringyesAbsolute http(s) URL of an audio or video file, up to 2048 characters, in a recognised container (MP4/MOV, Matroska/WebM, AVI, Ogg, WAV, FLAC, AIFF or MP3); its first audio stream is decoded to mono.
peaksintegernoNumber of buckets to return, 1 to 4000, default 200; each is the largest absolute sample in an equal slice of the track, scaled to 0..1 against 16-bit full scale. Default: 200.
sample_rateintegernoDecode rate in Hz, one of 4000, 8000, 11025, 16000, 22050 or 44100, default 8000; it sets sample_count and how finely each bucket is scanned. Default: 8000.

Limits

LimitValue
Size cap100 MB (104,857,600 bytes)
Timeout90 s
Show the JSON Schema the handler validates against
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "format": "uri",
      "description": "Absolute http(s) URL of an audio or video file, up to 2048 characters, in a recognised container (MP4/MOV, Matroska/WebM, AVI, Ogg, WAV, FLAC, AIFF or MP3); its first audio stream is decoded to mono."
    },
    "peaks": {
      "default": 200,
      "description": "Number of buckets to return, 1 to 4000, default 200; each is the largest absolute sample in an equal slice of the track, scaled to 0..1 against 16-bit full scale.",
      "type": "integer",
      "minimum": 1,
      "maximum": 4000
    },
    "sample_rate": {
      "default": 8000,
      "description": "Decode rate in Hz, one of 4000, 8000, 11025, 16000, 22050 or 44100, default 8000; it sets sample_count and how finely each bucket is scanned.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Example

The published example, verbatim: the request and the response it returns.

Request
POST /v1/waveform-data
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "url": "https://grist.tools/samples/av/waveform-beeps.wav",
  "peaks": 20,
  "sample_rate": 8000
}

Without the payment-signature header the call answers 402 with the payment requirements, including this endpoint's price and its max_timeout_seconds, so the deadline is known before anything is paid. The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case we cannot state for you is a settlement call that fails without answering: the error message says so when that is what happened.

Response200 OK
200 OK
payment-response: <base64 settlement receipt>

{
  "source_url": "https://grist.tools/samples/av/waveform-beeps.wav",
  "bytes": 32044,
  "container": "wav",
  "sample_rate": 8000,
  "sample_count": 16000,
  "duration_seconds": 2,
  "peak_count": 20,
  "peaks": [
    0.25,
    0.25,
    0.25,
    0.25,
    0,
    0,
    0,
    0.5,
    0.5,
    0.5,
    0.5,
    0,
    0,
    0,
    0.8999,
    0.8999,
    0.8999,
    0.8999,
    0,
    0
  ]
}

Sample file: av/waveform-beeps.wav. Two-second mono 16-bit PCM WAV at 8 kHz: three 0.4 s 500 Hz triangle-wave beeps at rising level separated by silence, generated from integer arithmetic.

In the sample itself: The RIFF header counts 32,036 bytes after itself, and the fmt chunk, in its own field order, declares audio format 1 (integer PCM), 1 channel, 8,000 Hz, 16,000 bytes per second, a block align of 2 bytes and 16 bits per sample. The data chunk right after it holds 32,000 bytes of samples, 2 s at that rate.

Response fields

FieldTypeIn the example
source_urlstring"https://grist.tools/samples/av/waveform-beeps.wav"
bytesnumber32044
containerstring"wav"
sample_ratenumber8000
sample_countnumber16000
duration_secondsnumber2
peak_countnumber20
peaksarray20 items

Deterministic: the same input returns the same output. Clock-derived fields, when present, are declared in the response.

Call it from code

The client reads the 402, signs the payment and retries on its own.

// waveform-data: $0.003 per call, paid in USD Coin on eip155:8453 via x402
// Install: npm install @x402/fetch@2 @x402/evm@2 viem@2
// Save as client.mjs (ES module, Node 18+), export EVM_PRIVATE_KEY with the paying wallet's key in your shell, then run: node client.mjs
// The wrapper reads the 402 (payment-required), signs and retries with payment-signature.
import { wrapFetchWithPayment, x402Client, decodePaymentResponseHeader } from '@x402/fetch'
import { ExactEvmScheme } from '@x402/evm/exact/client'
import { privateKeyToAccount } from 'viem/accounts'

const account = privateKeyToAccount(process.env.EVM_PRIVATE_KEY)
const client = new x402Client().register('eip155:8453', new ExactEvmScheme(account))
const fetchWithPayment = wrapFetchWithPayment(fetch, client)

const body = {
  "url": "https://grist.tools/samples/av/waveform-beeps.wav",
  "peaks": 20,
  "sample_rate": 8000
}

const res = await fetchWithPayment('https://grist.tools/v1/waveform-data', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify(body),
})
console.log(res.status, await res.json())
const settle = res.headers.get('payment-response')
if (settle) console.log(decodePaymentResponseHeader(settle).transaction)

Errors

Every error is typed JSON. Only a successful call is settled.

CodeHTTPWhen
invalid_input400The body does not match the schema on this page. Nothing is charged. The body does not match the schema; its fields are url, peaks and sample_rate.
blocked_target403The destination is refused by the network guard: a disallowed address, or, for HTTP requests, a scheme other than http/https, a port other than 80/443, or credentials in the URL.
unreachable_target424The destination you named did not resolve or refused the connection.
upstream_timeout424The destination you named did not answer before the declared timeout for this endpoint expired.
unsupported_content_type415The destination returned a type this endpoint does not handle.
too_large413The response exceeded the size cap while streaming, or decompressed at more than the allowed ratio.
unprocessable422The bytes arrived but could not be processed, for instance a malformed document.
internal500Our fault, and in almost every case nothing is charged. The exceptions come after the call has run and the settlement call was made: the message "The work was done but settlement could not be completed", and the messages starting with "Payment settlement returned". There, whether the payment moved is unknown to us as well. The payment moves at most once: its nonce is single-use and settlement is idempotent, so a retry with it is never charged twice. A retry is normally refused with a 402: replay_consumed, an expiry reason, or a reason saying the nonce was already used once the transfer is on-chain. Only if our server restarted before the transfer was final can a retry run the call again. Even then, the payment moves at most once. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain; to call again, sign a new payment.
rate_limited429Too many calls from the same payer, or too many calls towards the same destination domain. Nothing is charged.
concurrency_limit,
registry_at_capacity,
upstream_unavailable
503We could not serve the call right now. Retryable: wait the number of seconds in the retry-after header, then repeat the call. concurrency_limit and registry_at_capacity mean we were at capacity: the call did not run. You can send the same payment again if its validBefore is still far enough away to cover another call. If it is not, the retry gets a 402 authorization_validity_too_short: sign a new payment. upstream_unavailable means our internal service failed or did not answer in time: the call may already have run and the payment may have been settled. A retry with the same payment can get a 402 whose error field says why. authorization_validity_too_short: too little time is left before validBefore to cover another call. This check comes before the replay check, so it does not tell whether the first payment was settled. replay_consumed (the payment was used and may have been settled) or replay_exhausted (too many attempts): sign a new payment. replay_in_flight: the first call is still running, so wait and do not pay again. invalid_exact_evm_nonce_already_used: the transfer is already on-chain, so this payment cannot move again. Sign a new payment. An authorization can be settled only once, since its nonce is single-use. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain.
misconfigured503The service is not configured to serve calls. The call did not run and nothing is charged. It needs a fix on our side, so there is no retry delay to wait for.

Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.

Questions

How much does a call to the Waveform Data API cost?

$0.003 per call, paid in USD Coin on Base via x402. There is no account and no API key: the price is in the 402 answer, before anything is paid.

What is the timeout of waveform-data?

The endpoint itself runs for at most 90 s. max_timeout_seconds in the 402 answer is 111: that covers the whole call, including payment verification and settlement around it.

How large can a response from waveform-data be?

The response-size cap is 100 MB (104,857,600 bytes).

Is the waveform-data input schema free to read?

Yes. GET https://grist.tools/v1/waveform-data/schema returns the input schema for free, paid endpoints included.

What happens if a call to waveform-data fails?

The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case that cannot be stated in advance is a settlement call that fails without answering: the error message says so when that is what happened.

What does waveform-data return?

A JSON object with 8 top-level fields: source_url, bytes, container, sample_rate, sample_count, duration_seconds, peak_count and peaks. The example on this page is a real call over av/waveform-beeps.wav.