Detect a template’s fillable fields

POST

/v1/templates/:id/inspect

POST

/v1/templates/:id/inspect

$ curl -X POST https://api.cloudraker.com/v1/templates/id/inspect \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "fields": [
3     {
4       "name": "fullName",
5       "type": "text",
6       "label": "Full Name",
7       "page": 1,
8       "bbox": [
9         72,
10         720,
11         300,
12         740
13       ]
14     },
15     {
16       "name": "emailAddress",
17       "type": "email",
18       "label": "Email Address",
19       "page": 1,
20       "bbox": [
21         72,
22         680,
23         300,
24         700
25       ]
26     },
27     {
28       "name": "dateOfBirth",
29       "type": "date",
30       "label": "Date of Birth",
31       "page": 2,
32       "bbox": [
33         72,
34         650,
35         200,
36         670
37       ]
38     },
39     {
40       "name": "subscribeNewsletter",
41       "type": "checkbox",
42       "label": "Subscribe to newsletter",
43       "page": 2,
44       "bbox": [
45         72,
46         600,
47         90,
48         620
49       ]
50     }
51   ],
52   "pageBoxes": [
53     {
54       "page": 1,
55       "width": 612,
56       "height": 792
57     },
58     {
59       "page": 2,
60       "width": 612,
61       "height": 792
62     }
63   ],
64   "pageCount": 2,
65   "detected": false
66 }

Enumerates the fillable fields in a pdf-form template, with the page geometry to draw them on.

The response is { fields, pageBoxes, pageCount, detected }. Each field carries its name, type, label, page and bounding box — the names you see here are exactly the keys POST /v1/runs/{id}/task expects when submitting a review.

If the PDF carries no form fields of its own, they are detected from the page instead and detected says so.

Idempotent, but the first call on a template can be slow while the document is analyzed. Later calls reuse that result and return promptly.

Learn more: Form filling guide

Enumerates the fillable fields in a `pdf-form` template, with the page geometry to draw them on. The response is `{ fields, pageBoxes, pageCount, detected }`. Each field carries its name, type, label, page and bounding box — the names you see here are exactly the keys [POST /v1/runs/{id}/task](https://docs.cloudraker.com/api/cloud-raker-api/runs/submit-run-task) expects when submitting a review. If the PDF carries no form fields of its own, they are detected from the page instead and `detected` says so. <Note> Idempotent, but the first call on a template can be slow while the document is analyzed. Later calls reuse that result and return promptly. </Note> **Learn more:** [Form filling guide](https://docs.cloudraker.com/capabilities/fill)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired>=1 character

Response

Field inventory + page geometry.

Errors

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error