Agent Protocol
Rules for agents:
- - Supply ALL required flags — the CLI will not prompt for missing parameters.
- Output is always JSON.
- Use
-d key=value (bracket notation) or -d '{"..": ".."}' (JSON) for body and array parameters.
Authentication
Set environment variables:
- -
DOCUSEAL_API_KEY — API key (required). Get yours at https://console.docuseal.com/api - INLINECODE3 —
global (default), europe, or full URL for self-hosted (e.g. https://docuseal.yourdomain.com)
Available Commands
| Command Group | What it does |
|---|
| INLINECODE7 | list, retrieve, update, archive, create-pdf, create-docx, create-html, clone, merge, update-documents |
| INLINECODE8 |
list, retrieve, archive, create, send-emails, create-pdf, create-docx, create-html, documents |
|
submitters | list, retrieve, update |
Read the matching reference file for detailed flags and examples.
Common Mistakes
| # | Mistake | Fix |
|---|
| 1 | Forgetting -d template_id=<id> on submissions create | INLINECODE12 is a flag; submitters and other body params go via INLINECODE13 |
| 2 |
Passing a plain file path as a URL |
--file accepts a local path; for remote files use
-d "documents[0][file]=https://..." |
| 3 |
Expecting array params as comma-separated | Arrays use bracket notation:
-d "template_ids[]=1" -d "template_ids[]=2" |
| 4 |
Using templates create-pdf without a Pro plan | Commands marked
(Pro) require a DocuSeal Pro subscription |
| 5 |
Sending to multiple recipients with submissions create | Use
submissions send-emails --emails a@b.com,c@d.com for bulk;
submissions create is per-submitter |
Common Patterns
List templates:
CODEBLOCK0
Create a template from a PDF and send for signing:
CODEBLOCK1
Create a submission with pre-filled fields (bracket notation):
CODEBLOCK2
Create a submission with pre-filled fields (JSON):
CODEBLOCK3
Check signing status:
CODEBLOCK4
Update a submitter:
CODEBLOCK5
When to Load References
代理协议
代理规则：
- - 提供所有必需的标志——CLI 不会提示缺失的参数。
- 输出始终为 JSON 格式。
- 使用 -d key=value（括号表示法）或 -d {..: ..}（JSON）传递主体和数组参数。
身份验证
设置环境变量：
- - DOCUSEALAPIKEY — API 密钥（必需）。请访问 https://console.docuseal.com/api 获取。
- DOCUSEAL_SERVER — global（默认）、europe，或自托管服务的完整 URL（例如 https://docuseal.yourdomain.com）
可用命令
| 命令组 | 功能说明 |
|---|
| templates | 列出、检索、更新、归档、创建 PDF、创建 DOCX、创建 HTML、克隆、合并、更新文档 |
| submissions |
列出、检索、归档、创建、发送邮件、创建 PDF、创建 DOCX、创建 HTML、文档 |
| submitters | 列出、检索、更新 |
请阅读对应的参考文件以获取详细的标志和示例。
常见错误
| # | 错误 | 修正方法 |
|---|
| 1 | 在 submissions create 中忘记 -d template_id=<id> | --template-id 是一个标志；提交者和其他主体参数通过 -d 传递 |
| 2 |
将纯文件路径作为 URL 传递 | --file 接受本地路径；远程文件请使用 -d documents[0][file]=https://... |
| 3 |
期望数组参数以逗号分隔 | 数组使用括号表示法：-d template
ids[]=1 -d templateids[]=2 |
| 4 |
在没有 Pro 计划的情况下使用 templates create-pdf | 标记为
(Pro) 的命令需要 DocuSeal Pro 订阅 |
| 5 |
使用 submissions create 发送给多个收件人 | 批量发送请使用 submissions send-emails --emails a@b.com,c@d.com；submissions create 是针对单个提交者的 |
常见模式
列出模板：
bash
docuseal templates list --q NDA --limit 20
从 PDF 创建模板并发送签署：
bash
docuseal templates create-pdf --file contract.pdf --name NDA
docuseal submissions send-emails --template-id 1001 --emails signer@example.com
创建带预填字段的提交（括号表示法）：
bash
docuseal submissions create --template-id 1001 \
-d submitters[0][email]=john@acme.com \
-d submitters[0][values][Company Name]=Acme Corp
创建带预填字段的提交（JSON）：
bash
docuseal submissions create --template-id 1001 \
-d {submitters: [{email: john@acme.com, values: {Company Name: Acme Corp}}]}
检查签署状态：
bash
docuseal submissions list --template-id 1001 --status pending
更新提交者：
bash
docuseal submitters update 201 --email new@acme.com --send-email
何时加载参考文件
