Templates

A template is an organization-level document you fill in over and over — a W-9, an onboarding packet, a claim form. Templates are persistent (no TTL), never parsed or indexed, and are referenced by fill as template: { "id": "…" }.

Templates are deliberately a different noun from files: files are the inputs a run reads and are subject to a TTL when a run creates them; templates are curated assets that live until you delete them.

Add a template

Two shapes, same as files — send url, or name + mimeType for a presigned upload.

$
curl -X POST https://api.cloudraker.com/v1/templates \
>
  -H "Authorization: Bearer $CLOUDRAKER_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{ "url": "https://www.irs.gov/pub/irs-pdf/fw9.pdf", "name": "w9-template.pdf" }'

1
{
2
  "object": "template",
3
  "id": "23e0a865-0be9-45b1-a491-f1b6bd58a31a",
4
  "name": "w9-template.pdf",
5
  "mimeType": "application/pdf",
6
  "kind": "pdf-form",
7
  "status": "uploading",
8
  "createdAt": "2026-07-25T18:01:28.026Z"
9
}

status moves uploading → ready. Templates are not parsed, so they reach ready as soon as the bytes land — usually seconds.

Read, list, delete

$
# one template — includes a signed downloadUrl (~1 hour)
$
curl https://api.cloudraker.com/v1/templates/23e0a865-0be9-45b1-a491-f1b6bd58a31a \
>
  -H "Authorization: Bearer $CLOUDRAKER_API_KEY"
$
$
# the library — picker rows, newest first, no download URLs
$
curl "https://api.cloudraker.com/v1/templates?limit=50" \
>
  -H "Authorization: Bearer $CLOUDRAKER_API_KEY"
$
$
# remove one
$
curl -X DELETE https://api.cloudraker.com/v1/templates/23e0a865-0be9-45b1-a491-f1b6bd58a31a \
>
  -H "Authorization: Bearer $CLOUDRAKER_API_KEY"

?limit caps the page (1–200, default 50). There is no cursor — the list is a single newest-first page. DELETE returns 204.

Inspect the fields

POST /v1/templates/:id/inspect returns the field inventory with page geometry. Fields are detected when the PDF carries no fillable form. The first call can be slow; later calls reuse the result.

$
curl -X POST https://api.cloudraker.com/v1/templates/23e0a865-0be9-45b1-a491-f1b6bd58a31a/inspect \
>
  -H "Authorization: Bearer $CLOUDRAKER_API_KEY"

1
{
2
  "fields": [
3
    {
4
      "name": "topmostSubform[0].Page1[0].f1_01[0]",
5
      "type": "text",
6
      "label": "1 Name of entity/individual. An entry is required.",
7
      "required": false,
8
      "page": 0,
9
      "order": 0,
10
      "box": { "x": 58.6, "y": 118.0, "w": 517.4, "h": 14 },
11
      "multiline": false
12
    }
13
    // …22 more on this form
14
  ],
15
  "pageBoxes": [{ "width": 611.976, "height": 791.968 }],
16
  "pageCount": 6,
17
  "detected": false
18
}

Fill from a template

$
curl -X POST https://api.cloudraker.com/v1/fill \
>
  -H "Authorization: Bearer $CLOUDRAKER_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "template": { "id": "23e0a865-0be9-45b1-a491-f1b6bd58a31a" },
>
    "files": [{ "id": "a04d6597-4e34-4a99-94ea-964c289a4c68" }]
>
  }'

Fill also accepts template: { "url": "…" } for a one-off form. That copy is fetched at run time and is not added to your template library — use it for a form you’ll never see again, and a saved {id} for one you fill weekly.

Next steps