Analyze document with AI - SpitShake

POST

/

api

/

templates

/

{template_id}

/

ai

/

analyze

Error

A valid request URL is required to generate request examples

{}

Authorizations

X-Auth-Token

string

header

required

API token generated at Settings > API

Path Parameters

template_id

string

required

Body

application/json

type

enum<string>

required

Available options:

detect_rotations,

extract_fields

Response

Analysis result

The response is of type object.

AI-powered field detectionAutomatically detect and create form fields from a document using AI. 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`). See the [AI Field Detection Pipeline guide](/guides/ai-field-detection-pipeline) for details. Existing consumers are unaffected — the new fields are additive.

Error

A valid request URL is required to generate request examples

{}