Extract Embedded Data

POST /v1/extract Returns the JSON data embedded in a Forme PDF. See Embedded Data. On the hosted API, a render of a JSX template (sync or async) embeds the request data automatically. PDFs from HTML templates and from /v1/render/html have no embedded data. A PDF rendered locally with embedData also works. Extract is not counted as an operation. It shares the render rate limit.

Request

Send the raw PDF bytes as the body, with Content-Type: application/pdf or application/octet-stream. Maximum 10 MB.

curl -X POST https://api.formepdf.com/v1/extract \
  -H "Authorization: Bearer forme_sk_abc123..." \
  -H "Content-Type: application/pdf" \
  --data-binary @invoice.pdf

const res = await fetch("https://api.formepdf.com/v1/extract", {
  method: "POST",
  headers: {
    Authorization: "Bearer forme_sk_abc123...",
    "Content-Type": "application/pdf",
  },
  body: fs.readFileSync("invoice.pdf"),
});

const { data } = await res.json();

import requests

res = requests.post(
    "https://api.formepdf.com/v1/extract",
    headers={
        "Authorization": "Bearer forme_sk_abc123...",
        "Content-Type": "application/pdf",
    },
    data=open("invoice.pdf", "rb").read(),
)

print(res.json()["data"])

Response

200 OK

{ "data": { "clientName": "Jane Smith", "items": [ ... ] } }

404 {"error": "No embedded data found in this PDF"} when the PDF has no Forme embedded data.

The self-hosted server does not have /v1/extract. To extract without the hosted API, use extractData() from @formepdf/core.

Getting Started

Template Library

Reference

Hosted API

Self-Hosted API Reference

Concepts

Enterprise

SDKs

Guides

Changelog

Extract Embedded Data

Request

Response

​Request

​Response

Request

Response