Docassemble API

Name: Docassemble API
Brand: Docassemble API
Availability: InStock

✓ Official Vendor SpecProductivityForms SurveysapiKey25 EndpointsREST

For Agents

Drive guided interviews and document assembly on a docassemble server, manage users and files, and automate intake-to-document pipelines.

Install Jentic One Beta

Connect the Docassemble API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Docassemble API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Docassemble API.

Start a new interview session from a YAML interview file

Step through interview questions, posting answers to advance the session

Go back to a previous interview screen or trigger a defined action

GET STARTED

Start building with Docassemble API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Docassemble API for, with concrete tasks.

★ Embedded Legal Intake

A legal aid organisation can embed a docassemble interview into its website and step the user through it via the API rather than redirecting to the docassemble UI. POST /api/session/new starts the interview, GET /api/session/question reads the next question, and POST /api/session submits answers. The result is a branded intake flow that still benefits from the underlying interview logic.

POST /api/session/new with the interview filename, then loop calling /api/session/question and POST /api/session until completion.

Document Assembly Pipeline

Use the API to script document generation in batch - for example, generating tenant notices, immigration forms or contracts from CSV input. A worker process starts a session per row, posts the answers, and retrieves the assembled PDF from /api/file/{file_number}. Cuts manual drafting time on repetitive document workflows.

For each row in a CSV, start a new session, post answers, then call /api/file/{file_number} to download the resulting PDF and save it under the row id.

User and Server Administration

Operations teams running a multi-tenant docassemble server can automate user provisioning, package updates and configuration changes via the API. Endpoints under /api/user, /api/user_list and the configuration routes let an admin script bulk-add users from an HR feed or roll a new package version across instances.

Iterate the HR export and POST /api/user/new for each new hire, then GET /api/user_list to verify the count matches.

AI Agent Legal Tech Assistant

Through Jentic, an AI assistant can guide a user through a docassemble interview by translating natural-language replies into the structured answers the API expects. The agent searches Jentic for the interview intent, loads the session operations, and posts answers back. This combines docassemble's structured legal logic with conversational UX.

Use Jentic to search 'docassemble session question', load /api/session/question, and execute it after each user reply, posting answers back to /api/session.

Key Endpoints

25 endpoints — docassemble is an open-source platform for guided interviews that assemble legal documents and intake forms.

METHOD

PATH

DESCRIPTION

POST

/api/session/new

Start a new interview session

GET

/api/session/question

Get the current question for a session

POST

/api/session

Submit answers to advance the session

POST

/api/session/back

Go back to the previous question

POST

/api/session/action

Trigger a defined interview action

GET

/api/interviews

List interviews on the server

GET

/api/file/{file_number}

Download an assembled file

POST

/api/user/new

Create a new user on the server

POST

/api/session/new

Start a new interview session

GET

/api/session/question

Get the current question for a session

POST

/api/session

Submit answers to advance the session

POST

/api/session/back

Go back to the previous question

POST

/api/session/action

Trigger a defined interview action

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Docassemble X-API-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'start a docassemble interview' or 'submit interview answers', and Jentic returns the matching Docassemble operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Docassemble API through Jentic.

What authentication does the Docassemble API use?

Docassemble uses an API key in the X-API-Key header. Keys are issued per user on the host docassemble server. When called through Jentic, the key lives in your Jentic One instance and the agent receives only a scoped reference.

Can I drive an entire interview through the Docassemble API?

Yes. Start the session with POST /api/session/new, then loop calling GET /api/session/question to read the next prompt and POST /api/session with the answers. /api/session/back and /api/session/action handle navigation and custom triggers.

What are the rate limits for the Docassemble API?

Docassemble is typically self-hosted, so rate limits are governed by the host server's resources rather than a vendor quota. Treat heavy batch jobs carefully and watch CPU on the docassemble worker nodes.

How do I retrieve an assembled document with the Docassemble API through Jentic?

After completing an interview, call GET /api/file/{file_number} to download the assembled PDF or DOCX. Through Jentic, search 'docassemble download file', load the operation and execute it with the file number returned by the session.

Can I create users on a Docassemble server with the API?

Yes. POST /api/user/new creates a new user account on the server, and GET /api/user_list returns the current roster, which makes it straightforward to sync users from an HR or directory system.

Is the Docassemble API free?

Docassemble itself is open source and free to self-host, so API access has no vendor cost. Your only costs are the server hosting and any commercial extensions you install on top.

Can I limit what my agent is allowed to do with the Docassemble API?

Yes. Because Jentic One is self-hosted, you decide which Docassemble operations your agent may call and which credentials it may use, so you can grant only session operations such as starting an interview with POST /api/session/new and submitting answers with POST /api/session. Higher-impact operations like creating a user with POST /api/user/new stay off limits unless you explicitly add them to the agent's scope. Your X-API-Key is stored by your own Jentic One instance and injected at execution, so the agent works within the exact set of operations you allow.

Docassemble API

Connect the Docassemble API to your agent

Capabilities

Start building with Docassemble API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs