Propose a redline on a draft document

Anchors a verbatim quote from the document text and proposes an insert/delete/replace. Auto-attaches {page, bbox} when the quote resolves against per-word geometry. Status stays pending until a human or agent accepts/rejects; the source document is never mutated — accepting materializes a derived counter-proposal draft.

POST/revisions

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

document_idstringrequired

kindstringrequired

Allowed:insertdeletereplace

anchor_quotestringrequired

Verbatim excerpt the edit attaches to

proposed_textstring

Replacement (replace) or inserted text (insert)

rationalestring

review_cell_idstring

Responses

201

Pending revision created

idstringrequired

document_idstringrequired

review_cell_idstring | null

kindstringrequired

Allowed:insertdeletereplace

statusstringrequired

Allowed:pendingacceptedrejected

anchor_quotestringrequired

anchor_pageinteger | null

anchor_bboxobject | null

Show properties

xnumber

ynumber

widthnumber

heightnumber

proposed_textstring | null

rationalestring | null

derived_document_idstring | null

created_bystringrequired

created_atstring<date-time>required

resolved_atstring<date-time> | null

400

Invalid request parameters

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

404

Resource not found

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

document_idstring*kindstring*anchor_quotestring*Verbatim excerpt the edit attaches toproposed_textstringReplacement (replace) or inserted text (insert)rationalestringreview_cell_idstring

Request

curl -X POST "https://api.seal.nyc/api/v1/revisions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "document_id": "string",
  "kind": "insert",
  "anchor_quote": "string",
  "proposed_text": "string",
  "rationale": "string",
  "review_cell_id": "string"
}'

const response = await fetch("https://api.seal.nyc/api/v1/revisions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"document_id\": \"string\",\n  \"kind\": \"insert\",\n  \"anchor_quote\": \"string\",\n  \"proposed_text\": \"string\",\n  \"rationale\": \"string\",\n  \"review_cell_id\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/revisions",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"document_id\": \"string\",\n  \"kind\": \"insert\",\n  \"anchor_quote\": \"string\",\n  \"proposed_text\": \"string\",\n  \"rationale\": \"string\",\n  \"review_cell_id\": \"string\"\n}",
)

Response

{
  "id": "string",
  "document_id": "string",
  "review_cell_id": "string",
  "kind": "insert",
  "status": "pending",
  "anchor_quote": "string",
  "anchor_page": 0,
  "anchor_bbox": {
    "x": 0,
    "y": 0,
    "width": 0,
    "height": 0
  },
  "proposed_text": "string",
  "rationale": "string",
  "derived_document_id": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

{
  "type": "VALIDATION_ERROR",
  "status": 400,
  "title": "Validation failed",
  "details": {
    "email": [
      "Must be a valid email address"
    ]
  }
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "title": "Document not found"
}