Video Thumbnail API

Grabs a single frame from a video at a chosen timestamp as a PNG or JPEG, optionally scaled to a width.

Updated

Agents read this page asGET /v1/video-thumbnail/schemafree: schema, examples, errors, price

Endpoint
POST /v1/video-thumbnail
Price
$0.003 per call
Timeout
60 s
max_timeout_seconds
81 (the whole call as the 402 envelope sells it: the timeout, plus payment verification and settlement around it)
Response cap
200 MB (209,715,200 bytes)

When to use it

Seeking and decoding one frame 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.

Your source is AVI, MKV, MP4 or Ogg and you need JPEG or PNG.

When not to use it

  • The input is over 200 MB (209,715,200 bytes): video-thumbnail answers too_large (413).
  • The destination needs more than 60 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/video-thumbnail/schema.

FieldTypeRequiredDescription
urlstringyesAbsolute http(s) URL of the video, at most 2048 characters; the container (MP4/MOV, MKV/WebM, AVI or Ogg) is detected from the bytes.
time_secondsnumbernoTimestamp of the frame to grab, in seconds from the start (0 to 86400, default 0); a time past the end fails with no_frame. Default: 0.
formatstringnoEncoding of the returned frame: png (default) or jpeg. One of: "png", "jpeg". Default: "png".
widthintegernoOutput width in pixels (16 to 4096); the height keeps the aspect ratio, rounded to an even number. Native size when omitted.

Limits

LimitValue
Largest source file200 MB (209,715,200 bytes)
Timeout60 s
Source formatsAVI, MKV, MP4, Ogg
Output formatsJPEG, PNG
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 the video, at most 2048 characters; the container (MP4/MOV, MKV/WebM, AVI or Ogg) is detected from the bytes."
    },
    "time_seconds": {
      "default": 0,
      "description": "Timestamp of the frame to grab, in seconds from the start (0 to 86400, default 0); a time past the end fails with no_frame.",
      "type": "number",
      "minimum": 0,
      "maximum": 86400
    },
    "format": {
      "default": "png",
      "description": "Encoding of the returned frame: png (default) or jpeg.",
      "type": "string",
      "enum": [
        "png",
        "jpeg"
      ]
    },
    "width": {
      "description": "Output width in pixels (16 to 4096); the height keeps the aspect ratio, rounded to an even number. Native size when omitted.",
      "type": "integer",
      "minimum": 16,
      "maximum": 4096
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Example

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

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

{
  "url": "https://grist.tools/samples/av/thumbnail-clip.mp4",
  "time_seconds": 1,
  "format": "png"
}

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/thumbnail-clip.mp4",
  "bytes": 2587,
  "container": "mp4",
  "time_seconds": 1,
  "format": "png",
  "width": 128,
  "height": 72,
  "image_bytes": 292,
  "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAIAAAABICAIAAACx52pFAAAACXBIWXMAAAABAAAA..."
}

Sample file: av/thumbnail-clip.mp4. Three-second 128x72 MP4 at 2 fps with PNG-coded frames: a flat blue field with a 32x32 yellow square that slides 16 px right per frame, built with ffmpeg in bit-exact mode.

In the sample itself, the ftyp box names major brand isom, minor version 512 and compatible brands isom, iso2 and mp41; the top-level boxes run ftyp, free, mdat and moov, so the moov index comes after the media data; mvhd counts 3,000 ticks at 1,000 per second, 3 s; the 1 track is vide with sample entry mp4v. In the returned file: its IHDR chunk declares 128 by 72 pixels, 8-bit truecolour RGB and no interlacing. The next chunk is pHYs.

Response fields

FieldTypeIn the example
source_urlstring"https://grist.tools/samples/av/thumbnail-clip.mp4"
bytesnumber2587
containerstring"mp4"
time_secondsnumber1
formatstring"png"
widthnumber128
heightnumber72
image_bytesnumber292
image_base64stringa string of 67 characters

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.

// video-thumbnail: $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/thumbnail-clip.mp4",
  "time_seconds": 1,
  "format": "png"
}

const res = await fetchWithPayment('https://grist.tools/v1/video-thumbnail', {
  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, time_seconds, format and width.
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. The source is not a type video-thumbnail reads; it reads AVI, MKV, MP4 and Ogg.
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.

Conversions

Ready-made calls to this API, one page each.

ConversionRecorded sampleSourceOutput
AVI to JPEGav/pair-clip.avi74.5 KB389 bytes
AVI to PNGav/pair-clip.avi74.5 KB186 bytes
MKV to JPEGav/pair-clip.mkv10.3 KB389 bytes
MKV to PNGav/pair-clip.mkv10.3 KB186 bytes
MP4 to JPEGav/pair-clip.mp411 KB389 bytes
MP4 to PNGav/pair-clip.mp411 KB186 bytes
Ogg to JPEGav/pair-clip.ogg12.3 KB383 bytes
Ogg to PNGav/pair-clip.ogg12.3 KB705 bytes

Questions

How much does a call to the Video Thumbnail 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 video-thumbnail?

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

How large can a response from video-thumbnail be?

The response-size cap is 200 MB (209,715,200 bytes).

Is the video-thumbnail input schema free to read?

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

What happens if a call to video-thumbnail 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 video-thumbnail return?

A JSON object with 9 top-level fields: source_url, bytes, container, time_seconds, format, width, height, image_bytes and image_base64. The example on this page is a real call over av/thumbnail-clip.mp4.