Bake highlight/text/rect/redact ops onto a draft PDF

POST/documents/pdf/annotate

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Request body

requiredapplication/json

idstringrequired

operationsobject[]required

Show properties

Array of object

opstringrequired

Allowed:highlighttextrectredact

pageintegerrequired

xnumber

ynumber

widthnumber

heightnumber

textstring

sizenumber

colorstring

Responses

200

Annotated

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST "https://api.seal.nyc/api/v1/documents/pdf/annotate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "operations": [
    {
      "op": "highlight",
      "page": 0,
      "x": 0,
      "y": 0,
      "width": 0,
      "height": 0,
      "text": "string",
      "size": 0,
      "color": "string"
    }
  ]
}'

const response = await fetch("https://api.seal.nyc/api/v1/documents/pdf/annotate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"id\": \"string\",\n  \"operations\": [\n    {\n      \"op\": \"highlight\",\n      \"page\": 0,\n      \"x\": 0,\n      \"y\": 0,\n      \"width\": 0,\n      \"height\": 0,\n      \"text\": \"string\",\n      \"size\": 0,\n      \"color\": \"string\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/documents/pdf/annotate",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"id\": \"string\",\n  \"operations\": [\n    {\n      \"op\": \"highlight\",\n      \"page\": 0,\n      \"x\": 0,\n      \"y\": 0,\n      \"width\": 0,\n      \"height\": 0,\n      \"text\": \"string\",\n      \"size\": 0,\n      \"color\": \"string\"\n    }\n  ]\n}",
)

Response

Annotated