# PDF Metadata API

> Reads a PDF's page count, document-info fields, version and encryption flag without rendering it.

- Endpoint: `POST https://grist.tools/v1/pdf-metadata`
- Price: $0.005 per successful call, paid via x402 in USDC on Base
- Timeout: 25 s; max_timeout_seconds in the 402: 46 (the timeout plus payment verification and settlement)
- Response cap: 25 MB (26,214,400 bytes)
- Family: [Documents](https://grist.tools/tools/documents)
- Input schema, free: https://grist.tools/v1/pdf-metadata/schema
- Updated: 2026-11-13

## When to use it

Reading a PDF trailer needs a real PDF parser and a hardened fetch: an agent that pulls the URL itself walks past every SSRF control, and carrying a PDF library per call is not something an agent does inline.

## When not to use it

- The input is over 25 MB (26,214,400 bytes): pdf-metadata answers too_large (413).
- The destination needs more than 25 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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | yes | Absolute http(s) URL of the PDF, up to 2048 characters; redirects are followed, the body must start with %PDF-, and an encrypted file is still described without being decrypted. |

## Limits

| Limit | Value |
| --- | --- |
| Size cap | 25 MB (26,214,400 bytes) |
| Timeout | 25 s |

## Example

Request:

```http
POST /v1/pdf-metadata
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "url": "https://grist.tools/samples/documents/metadata-brochure.pdf"
}
```

Response (200 OK, with a payment-response settlement receipt header):

```json
{
  "source_url": "https://grist.tools/samples/documents/metadata-brochure.pdf",
  "bytes": 1010,
  "version": "1.7",
  "pages": 1,
  "encrypted": false,
  "title": "Sample Brochure",
  "author": "Grist Samples",
  "subject": "Public test document",
  "keywords": "sample metadata test",
  "creator": "grist.tools",
  "producer": "grist.tools",
  "creation_date": "2000-01-01T00:00:00.000Z",
  "modification_date": "2000-01-01T00:00:00.000Z"
}
```

Sample file: documents/metadata-brochure.pdf. One-page PDF whose info dictionary sets title, author, subject and keywords, with dates, creator and producer pinned by pdf-lib.

Response fields:

| Field | Type | In the example |
| --- | --- | --- |
| `source_url` | string | "https://grist.tools/samples/documents/metadata-brochure.pdf" |
| `bytes` | number | 1010 |
| `version` | string | "1.7" |
| `pages` | number | 1 |
| `encrypted` | boolean | false |
| `title` | string | "Sample Brochure" |
| `author` | string | "Grist Samples" |
| `subject` | string | "Public test document" |
| `keywords` | string | "sample metadata test" |
| `creator` | string | "grist.tools" |
| `producer` | string | "grist.tools" |
| `creation_date` | string | "2000-01-01T00:00:00.000Z" |
| `modification_date` | string | "2000-01-01T00:00:00.000Z" |

## Call it from code

```js
// pdf-metadata: $0.005 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/documents/metadata-brochure.pdf"
}

const res = await fetchWithPayment('https://grist.tools/v1/pdf-metadata', {
  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)
```

```python
# pdf-metadata: $0.005 per call, paid in USD Coin on eip155:8453 via x402
# Install: pip install "x402[requests,evm]>=2.24,<3"
# The session reads the 402 (payment-required), signs and retries with payment-signature.
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http import decode_payment_response_header
from x402.http.clients.requests import x402_requests
from x402.mechanisms.evm.exact import register_exact_evm_client
from x402.mechanisms.evm.signers import EthAccountSigner

account = Account.from_key(os.environ["EVM_PRIVATE_KEY"])
client = x402ClientSync()
register_exact_evm_client(client, EthAccountSigner(account), networks="eip155:8453")
session = x402_requests(client)

payload = {
    "url": "https://grist.tools/samples/documents/metadata-brochure.pdf"
}

res = session.post("https://grist.tools/v1/pdf-metadata", json=payload)
print(res.status_code, res.json())
settle = res.headers.get("payment-response")
if settle:
    print(decode_payment_response_header(settle).transaction)
```

```sh
# pdf-metadata: $0.005 per call, paid in USD Coin on eip155:8453 via x402
# 1. Unpaid call: HTTP 402, the requirements in the payment-required header (base64 JSON) and in the body.
curl -i -X POST 'https://grist.tools/v1/pdf-metadata' -H 'content-type: application/json' -d '{"url":"https://grist.tools/samples/documents/metadata-brochure.pdf"}'

# 2. Same call with the signed payment (an EIP-3009 authorization, EIP-712 signed: it cannot be
#    typed by hand). x-payment is accepted as the v1 alternative. HTTP 200 carries payment-response.
curl -i -X POST 'https://grist.tools/v1/pdf-metadata' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"url":"https://grist.tools/samples/documents/metadata-brochure.pdf"}'
```

## Errors

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

| Code | HTTP | When |
| --- | --- | --- |
| `invalid_input` | 400 | The body does not match the schema on this page. Nothing is charged. |
| `blocked_target` | 403 | The 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_target` | 424 | The destination you named did not resolve or refused the connection. |
| `upstream_timeout` | 424 | The destination you named did not answer before the declared timeout for this endpoint expired. |
| `unsupported_content_type` | 415 | The destination returned a type this endpoint does not handle. |
| `too_large` | 413 | The response exceeded the size cap while streaming, or decompressed at more than the allowed ratio. |
| `unprocessable` | 422 | The bytes arrived but could not be processed, for instance a malformed document. |
| `internal` | 500 | Our 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_limited` | 429 | Too 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` | 503 | We 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. |
| `misconfigured` | 503 | The 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. |

## Questions

### How much does a call to the PDF Metadata API cost?

$0.005 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 pdf-metadata?

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

### How large can a response from pdf-metadata be?

The response-size cap is 25 MB (26,214,400 bytes).

### Is the pdf-metadata input schema free to read?

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

### What happens if a call to pdf-metadata 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 pdf-metadata return?

A JSON object with 13 top-level fields: source_url, bytes, version, pages, encrypted, title, author, subject, keywords, creator, producer, creation_date and modification_date. The example on this page is a real call over documents/metadata-brochure.pdf.

## Related

- [Documents APIs](https://grist.tools/tools/documents)
- [Parsing PDF, DOCX, XLSX and EPUB for agents](https://grist.tools/guides/document-parsing-api)
- [How AI agents pay for APIs with x402](https://grist.tools/guides/x402-payments-for-ai-agents)
- [All APIs](https://grist.tools/docs)

This page as HTML: https://grist.tools/docs/pdf-metadata. Every page of grist.tools has a Markdown version at its address plus .md.
