AI smart setup

Combined analysis — detects page rotations AND extracts form fields in a single call. Scans all documents in the template, not just the first.

For multi-document templates, the AI sees all PDFs in a single request and returns fields with unique names across documents (e.g., “CFA — Effective Date” vs “LPOA — Effective Date”). Each field includes a document_index indicating which document it belongs to, and areas[].attachment_uuid is set to the correct document UUID. Page numbers are per-document (1-indexed within each document).

The returned fields can be passed directly to PUT /api/templates/:id as the schema array. Note: smart_setup is read-only — it does not auto-persist the schema. You must PUT it separately after reviewing/adjusting the detected fields.

Accounts on the v2 detection pipeline receive additional response metadata (see pipeline property) and richer preferences on each field (canonical key, per-field confidence, anchor_text, and anchor_method).

Positioning pipeline: The v2 pipeline uses the PDF text layer to provide exact label and blank-line coordinates to the AI, enabling precise field placement. Fields are snapped to detected underscore runs (anchor_method: snapped_to_blank) with adaptive sizing based on measured blank dimensions. A visual verification pass reviews each page with field rectangles overlaid to catch positioning errors before returning results.

On v2, callers may optionally send context to provide advisory hints and expected canonical fields; legacy v1 silently ignores it.

POST

api

templates

{template_id}

smart_setup

Error

A valid request URL is required to generate request examples

{
  "document_summary": "<string>",
  "pages": [
    {
      "page_number": 123
    }
  ],
  "fields": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "required": true,
      "readonly": true,
      "key": "<string>",
      "default_value": "<string>",
      "placeholder": "<string>",
      "pattern": "<string>",
      "options": [
        "<string>"
      ],
      "formula": "<string>",
      "areas": [
        {
          "x": 123,
          "y": 123,
          "w": 123,
          "h": 123,
          "page": 123,
          "attachment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "preferences": {}
    }
  ],
  "field_count": 123,
  "pipeline": {
    "version": "v2",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "latency_ms": 123,
    "anchor_hits": 123,
    "anchor_misses": 123,
    "corrections_applied": 123,
    "critic_ran": true,
    "documents_scanned": 123,
    "verifier_ran": true
  }
}

Authorizations

X-Auth-Token

string

header

required

API token generated at Settings > API

Path Parameters

template_id

string

required

Body

application/json

detection_mode

enum<string>

default:all

library_only restricts detection to canonical field-library keys (no new keys are minted from labels).

Available options:

all,

library_only

context

object

Show child attributes

Response

Complete setup data

document_summary

string

pages

object[]

Show child attributes

fields

object[]

Show child attributes

field_count

integer

pipeline

object

Telemetry metadata attached to v2 AI field detection responses. Accounts on the legacy (v1) pipeline do not receive this block.

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "document_summary": "<string>",
  "pages": [
    {
      "page_number": 123
    }
  ],
  "fields": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "required": true,
      "readonly": true,
      "key": "<string>",
      "default_value": "<string>",
      "placeholder": "<string>",
      "pattern": "<string>",
      "options": [
        "<string>"
      ],
      "formula": "<string>",
      "areas": [
        {
          "x": 123,
          "y": 123,
          "w": 123,
          "h": 123,
          "page": 123,
          "attachment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "preferences": {}
    }
  ],
  "field_count": 123,
  "pipeline": {
    "version": "v2",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "latency_ms": 123,
    "anchor_hits": 123,
    "anchor_misses": 123,
    "corrections_applied": 123,
    "critic_ran": true,
    "documents_scanned": 123,
    "verifier_ran": true
  }
}

Overview

Partner API

Templates

Thumbnails

Submissions

Submitters

Users

Access Tokens

Webhooks

Settings

Custom Domains

Teams

Audit Events

MFA

BAA

Security Events

Subscriptions

Plans

Payments

Verification

KBA

AI

Embed

Health

AI smart setup

Authorizations

Path Parameters

Body

Response