Skip to main content
POST
/
superdoc
/
v1
/
annotate
Populate DOCX template fields
curl --request POST \
  --url https://api.case.dev/superdoc/v1/annotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "url": "<string>",
    "base64": "<string>"
  },
  "fields": [
    {
      "type": "text",
      "value": "<string>",
      "id": "<string>",
      "group": "<string>",
      "options": {
        "width": 123,
        "height": 123
      }
    }
  ],
  "output_format": "docx"
}
'
"<string>"

Authorizations

​
Authorization
string
header
required

API key starting with sk_case_

Body

application/json
​
document
object
required

Document source - provide either URL or base64

​
fields
object[]
required

Fields to populate in the template

​
output_format
enum<string>
default:docx

Output format for the annotated document

Available options:
docx,
pdf

Response

Annotated document

The response is of type file.