Jentic OSThe workplace. An in-house AI platform for every employeeJentic OneSafe access. Agents reach your systems without holding keysJentic AIRThe foundation. Gets your existing platforms ready for AI
Pricing

GET STARTED

API DirectoryBrowse 10,000+ APIs ready for AI agent integrationDocumentationGuides and API reference

TOOLS

API ScoringCheck your AI readiness using our scorecardArazzo UIVisualize Arazzo workflows as interactive documentationArazzo EditorBuild and edit multi-step API workflows visually

COMMUNITY

GitHubOpen source projects and examplesOpen StandardsBuilt on open specs. Never locked in.
All ResourcesEverything in one placeBlogLatest articles and insightsTech Talk NewsletterAPIs, AI agents, architecture and strategyWebinarsLive sessions and on-demand recordingsReports & WhitepapersOriginal research on enterprise AI
About UsOur mission and teamCareersJoin our teamContactGet in touch
Try it now
Jentic OSJentic OneJentic AIR
Pricing
API DirectoryDocumentationAPI ScoringArazzo UIArazzo EditorGitHubOpen Standards
All ResourcesBlogTech Talk NewsletterWebinarsReports & Whitepapers
About UsCareersContact
Try it now
JenticJentic
Products
  • Jentic OS
  • Jentic One
  • Jentic AIR
For Developers
  • API Directory
  • Documentation
  • GitHub
Company
  • About Jentic
  • Careers
  • Contact Us
  • Trust Centre
ISO/IEC 27001:2022 certification badge issued by Prescient SecurityISO/IEC 27001:2022 certification badge issued by Prescient Security

Information Security Management System

Certified to ISO/IEC 27001:2022 by Prescient Security

AICPA SOC for Service Organizations logoAICPA SOC for Service Organizations logo

SOC 2® Type 1 report

Audited by Prescient Assurance

Terms & Conditions•Privacy Policy•
© 2026 Jentic Technology Ltd. All rights reserved.
2 Grattan Court East, Dublin, D02 VX86, Ireland
Switch to light modeSwitch to dark mode
APIs / Productivity / Docassemble API
Docassemble API logo

Docassemble API

62
AI ReadinessAI-Aware (B-)62/100
See full scorecard
Official vendor OpenAPI document · agent-readyProductivityForms SurveysapiKey25 EndpointsREST

For Agents

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

Use for: Start a new docassemble interview for a tenant rights intake, Post answers to advance an in-progress interview to the next question, Go back to the previous question in an active session, Trigger a custom action defined in the interview

Not supported: Does not handle e-signature, court e-filing, payment processing, or general-purpose word-processor editing - use for guided interview and document assembly only.

Docassemble is an open-source platform for guided interviews that assemble legal documents and intake forms. Its API exposes 25 endpoints for starting and stepping through interview sessions, managing users, files, packages, the playground and server configuration. Authenticated via the X-API-Key header, it lets external apps embed legal-tech intake flows, automate document generation pipelines, and synchronise users with a host docassemble server.

Jentic One on GithubView OpenAPI Document

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.

1

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fdocassemble.org%2Fdocassemble" | sh
2

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fdocassemble.org%2Fdocassemble" | 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

Upload and download files attached to an interview session

List and create users on the docassemble server

Pull and update server configuration and packages

Use the playground endpoints for development workflows

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

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

Jentic AI Readiness Score

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

D

Docassemble API

- AI-Aware (B-)
62/100
76
Foundational Compliance
63
Developer Experience & Jentic Compatibility
48
AI-Readiness & Agent Experience
94
Agent Usability
50
Security
61
AI Discoverability
Powered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
76

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A-Signals: 4
98%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

7%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

63

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: B-Signals: 4
0%

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

50%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

48

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: D+Signals: 4
46%

Description Coverage

Coverage of descriptions across API elements.

0%

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

92%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

54%

Summary Coverage

Coverage of summaries across operations/tags/info.

94

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1
94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

50

Security

Trust, risk posture, and security compliance.

Grade: C-Signals: 1
50%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

61

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: B-Signals: 1
60%

Descriptive Richness

Clarity and depth of descriptions across API elements.

View full reportHow the score is calculatedMore about the dimensions

Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

Score your own APIScoring CLI agent skill
npx @jentic/api-scorecard-cli score <openapi-url>

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring Docassemble by hand means carrying its X-API-Key header, pointing at your own server host, and stepping through session state yourself. Through Jentic you install once, import the Docassemble API from the API Directory, store the key once, and your agent calls it.

Permission scoping

Docassemble drives interviews through session operations, so scope your agent to the operations it needs, such as starting a new session or submitting answers. You choose the operations it may call, so creating a user is not included unless you add it.

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.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Open edX LMS API

→

Open-source education platform - pairs with docassemble for legal-education interview content

Use Open edX when the task is course delivery rather than guided document interviews.

Alternative

Concord

→

Commercial contract lifecycle management platform - alternative when teams need e-signature and post-execution tracking on assembled documents

Choose Concord for a full CLM with e-signature; choose docassemble for guided interviews that build the document up front.

Complementary

GitHub REST API

→

Manage docassemble interviews stored as GitHub repositories.

Use GitHub to version-control docassemble package code.

Complementary

Twilio API

→

Trigger SMS reminders from a docassemble interview workflow.

Pair Twilio when SMS or voice prompts need to accompany a legal interview.

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.

GET STARTED

Start building with Docassemble API

Explore with Jentic One
View OpenAPI Document