canonical: https://jentic.com/apis/feathery.io/feathery # Feathery API Jentic publishes the only available OpenAPI specification for Feathery API, keeping it validated and agent-ready. Feathery is a form-building and document-intelligence platform that combines hosted forms, conditional logic, e-signature envelopes, and AI-powered extraction from uploaded documents. The REST API exposes 40 endpoints covering accounts, fields, forms, submissions, users, workspaces, document templates, and AI extraction runs so backends and agents can drive the full lifecycle of an applicant or onboarding flow. ## For AI agents Create and submit forms, fill document templates, and run AI document extractions through Feathery's REST API. ## Scope Does not handle payments, hosted authentication, or analytics dashboards - use for Feathery forms, submissions, and document intelligence only. ## Capabilities - Drive form submissions and inspect submitted field values - Run AI document intelligence extractions on uploaded files - Fill PDF templates and manage document envelopes for signature - Manage end users, workspaces, and account members programmatically - Rotate the workspace API key when credentials need to be cycled - Audit form activity through the logs endpoints ## Use cases ### Automated Onboarding with Document Intelligence Financial-services and HR teams use Feathery to host onboarding forms that collect ID documents and proof-of-address PDFs, then run AI extraction to pull out fields like name, address, and date of birth. The `/api/ai/run/{extraction_id}`/ endpoint kicks off a run and `/api/ai/run/batch/{extraction_id}`/ returns the structured results so the backend can pre-fill the next stage of onboarding without manual review. Example prompt: Upload a passport image to a Feathery form, call POST `/api/ai/run/{extraction_id}`/, then GET `/api/ai/run/batch/{extraction_id}`/ to retrieve extracted name and date of birth. ### Document Template Filling and E-Signature Operations teams use Feathery's document endpoints to fill PDF templates with submitted form data and route them through e-signature envelopes. POST `/api/document/fill`/ generates the populated PDF and the `/api/document/envelope`/ endpoints manage the signing flow, replacing manual PDF assembly for contracts, NDAs, and offer letters. Example prompt: Call POST `/api/document/fill`/ with template ID and form submission data, then create an envelope with POST `/api/document/envelope`/ for the signer. ### Form Submission Reconciliation Product teams reconcile Feathery submissions against their CRM or analytics warehouse. The submissions and fields endpoints expose what was submitted, by whom, and when, so a nightly job can hydrate downstream records without scraping the Feathery dashboard. Example prompt: List submissions for form ID xyz from the last 24 hours and upsert each record into the internal CRM. ### Agent-Built Applicant Workflow An AI agent assembling an applicant intake flow can use Jentic to discover Feathery's form, submission, and document operations, fill a template with applicant data, kick off a document extraction, and route the result to a reviewer - all without holding the raw Feathery API key in agent context. Example prompt: Use Jentic to search 'fill a feathery document template', execute POST `/api/document/fill`/, then POST `/api/ai/run/{extraction_id}`/ on the resulting file. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/api/document/fill/` | Fill a PDF template with submitted data | | POST | `/api/ai/run/{extraction_id}/` | Run AI document extraction | | GET | `/api/ai/run/batch/{extraction_id}/` | Get batch AI extraction results | | POST | `/api/document/envelope/` | Create a document envelope for signature | | GET | `/api/account/` | Get account information | | PATCH | `/api/account/rotate_key/` | Rotate the workspace API key | ## Key resources - **Account** — Manage account members, invites, and rotate the workspace API key - **Document Intelligence** — Run AI extractions on uploaded documents and retrieve batch results - **Documents** — Fill PDF templates, manage templates, and route envelopes for signature - **Forms** — List and inspect hosted forms and their fields - **Submissions** — Read submitted field values and submission metadata - **Users** — Manage end-user records associated with form submissions - **Workspaces** — Manage workspaces that scope forms, users, and credentials ## Why Jentic - **Setup:** Wiring the Feathery API by hand means formatting the key as a Token Authorization header and choosing the right regional host among its US, Canada, Europe, and Australia servers yourself. Through Jentic you install once, import Feathery from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Feathery puts the extraction id in the URL path (`/api/ai/run/{extraction_id}`/), so a rule can pin your agent to one extraction workflow. You choose the operations it may call, so a sensitive one like rotating the account key is not included unless you add it, while document-fill and run reads can stand on their own. - **Credential handling:** Your Feathery workspace API key is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'fill a Feathery document template', and Jentic returns the matching Feathery operation with its input schema so the agent calls the correct endpoint without parsing 40 paths. ## Related APIs - **Typeform** — Conversational form builder without document AI extraction - **Jotform** — Established form builder with broad template library - **SurveyMonkey** — Use SurveyMonkey for ongoing customer feedback alongside Feathery onboarding flows ## FAQ ### Why is there no official OpenAPI spec for Feathery API? Feathery does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Feathery API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Feathery API use? Feathery uses an API key passed in the Authorization header. Through Jentic the raw key sits in the vault and the agent receives a scoped credential reference, so the workspace key never enters agent context. ### Can I run AI document extraction with the Feathery API? Yes. POST `/api/ai/run/{extraction_id}`/ kicks off a run on an uploaded document, and GET `/api/ai/run/batch/{extraction_id}`/ returns the structured extraction results. ### What are the rate limits for the Feathery API? Feathery does not document per-endpoint rate limits in the spec; limits are set on the workspace plan. Implement retries with backoff on 429 responses and check your workspace settings for the active quota. ### How do I fill a PDF template with the Feathery API through Jentic? Run pip install jentic, search 'fill a feathery document template', load POST `/api/document/fill`/, and execute it with the template ID and field data to receive the filled PDF. ### How do I rotate my Feathery API key? Call PATCH `/api/account/rotate_key`/ to issue a new workspace API key. Update the stored credential in your vault immediately so subsequent calls use the new value. ### Can I limit what my agent is allowed to do with the Feathery API? Yes. Because you run Jentic One yourself, your own rules decide which Feathery operations and credentials the agent may use. You can grant it just document-fill (POST `/api/document/fill`/) and extraction reads while leaving out sensitive calls like rotating the workspace key (PATCH `/api/account/rotate_key`/) unless you explicitly add them. Since the extraction id lives in the path (`/api/ai/run/{extraction_id}`/), a rule can also pin the agent to one extraction workflow rather than every run.