Inspect a form template's fillable fields

POST

/actions/:id/template/inspect

POST

/actions/:id/template/inspect

$ curl -X POST https://api.cloudraker.com/actions/id/template/inspect \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "fileId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890"
> }'

1 {
2   "fields": [
3     {
4       "name": "topmostSubform[0].policyHolderName",
5       "type": "text",
6       "label": "Policy Holder Name",
7       "required": true,
8       "page": 0,
9       "order": 1,
10       "section": "Coverages ▸ General Liability",
11       "ignore": false,
12       "hint": "Enter the full legal name of the policy holder",
13       "options": [],
14       "maxLength": 100,
15       "multiline": false,
16       "box": {
17         "x": 72,
18         "y": 144,
19         "w": 300,
20         "h": 20
21       }
22     }
23   ],
24   "pageBoxes": [
25     {
26       "width": 612,
27       "height": 792
28     }
29   ],
30   "pageCount": 1,
31   "detected": true
32 }

Reads the PDF referenced by the JSON body — either { spaceId, fileId } (a file in that space) or { fileId } alone (an org-level template file) — detecting form fields when the document has none, and returns the field inventory with page geometry ({ fields, pageBoxes, pageCount, detected }). Idempotent; initial field detection can take longer, while later calls reuse the prior result. The file must be application/pdf and parented to :spaceId (when given) or to the caller’s organization (else 422 file_ineligible), and must have finished uploading (else 409 file_not_ready). Organization administrators only (denied → 403).

Reads the PDF referenced by the JSON body — either `{ spaceId, fileId }` (a file in that space) or `{ fileId }` alone (an org-level template file) — detecting form fields when the document has none, and returns the field inventory with page geometry (`{ fields, pageBoxes, pageCount, detected }`). Idempotent; initial field detection can take longer, while later calls reuse the prior result. The file must be `application/pdf` and parented to `:spaceId` (when given) or to the caller’s organization (else 422 `file_ineligible`), and must have finished uploading (else 409 `file_not_ready`). Organization administrators only (denied → 403).

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

fileIdstringRequired>=1 character

The template PDF to inspect.

spaceIdstringOptional

Space the file lives in. Omit for an organization-level template (parentType: organization).

Response

Field inventory and page geometry.

fieldslist of objects

pageBoxeslist of objects

Page size in points, one entry per page.

pageCountinteger-9007199254740991-9007199254740991

detectedboolean

True when the fields were detected rather than read from an existing AcroForm.

Errors

409

Conflict Error

422

Unprocessable Entity Error