add_email_domain
ChatGPTAdds a domain for email actions to send from, and returns the DNS records to add at the domain's DNS host. DocSpring checks for them every few minutes. Needs a paid monthly plan.
add_fields
ChatGPTAdds fields to a template's draft: on a PDF template they're placed on its pages, and on an HTML or Word template they define the data it uses (a Word template already has a field for each value its tags use). Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. A field with the name of another field shares its type, required, default and other shared settings: leave them out when you add a copy, since a different value is refused (update_fields changes them for every field with the name). Returns the fields it added, with their IDs.
combine_pdfs
ChatGPTMerges PDFs (submissions, templates, other combined PDFs or links) into one PDF, and waits for it. Its files.pdf.download_url works for 24 hours. A combined PDF always uses the account's credits, even when its PDFs are test PDFs.
copy_template
ChatGPTCopies a template (its draft, or a published version) to a new template, and waits until the copy's PDF is ready.
create_email_action
ChatGPTCreates an email action, which emails each submission's files once it's processed: an account email action, or one on a template with template_id. Without a paid plan, it only emails the account's team (test emails, and test submissions).
create_folder
ChatGPTCreates a template folder.
create_html_template
ChatGPTCreates an HTML template: DocSpring renders its HTML (a Liquid template) and SCSS as a PDF, with each submission's data. Set the page size and margins with html_engine_options: a CSS @page rule overrides the margins, leaving the header and footer no room. A new template HTML-escapes the values Liquid prints (its html_escape_data setting): write {{ notes | raw }} only for a value that holds HTML. Print amounts with the currency filter: {{ total | currency }} prints $1,234.50, and {{ total | currency: "€", ".", "," }} prints €1.234,50. In a submission, an unknown filter is skipped and an undefined variable prints nothing, without an error: preview_template reports both. Then add a field for each key of the data with add_fields (a name and a type, no position, with customer/name for a nested value and line_items/~/description for each item of a list): the fields are the template's data schema, which validate_data, get_model_code and forms use. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. Returns a summary of the template.
create_page_design
ChatGPTCreates a page design: a template whose PDFs DocSpring lays out from a JSON layout of sections and the elements in them (text with fields, images, tables, charts, checkboxes, fillable form fields, QR codes, barcodes, shapes, lines and HTML boxes), which the Page Designer in DocSpring edits. A section can repeat for each item of a list, and a table has a row for each one. DocSpring adds a field for each value the layout reads: get_template shows them, and update_fields sets their types and which are required. A layout with problems isn't saved, and the error lists each one by its JSON path, such as /sections/0/elements/2/width. Check how it prints with preview_template. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. Returns a summary of the template.
create_pdf_template
ChatGPTCreates a PDF template from a PDF, and waits until DocSpring has processed it. Give the PDF as a link, as base64, or (for a large local file) upload it with create_pdf_upload first. Then add fields with add_fields, or set detect_fields. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees.
create_pdf_upload
ChatGPTPrepares an upload of a local PDF or Word document (.docx or .odt), for agents that can run commands: use it for any file on disk, since base64 in a tool call only suits a small file. Run the curl command it returns, with the path to the file, then pass its cache_id to create_pdf_template, create_word_template or replace_template_pdf.
create_signature_request
ChatGPTAsks people to fill in and sign a template: creates a submission with a signature request for each signer, and returns a link for each one, for the user to send. The PDF is made once everyone has signed (get_submission shows it). Links expire: create_signing_link makes a new one.
create_signing_link
ChatGPTMakes a new link for a signer to open their signature request, such as when their link has expired.
create_webhook
ChatGPTCreates a webhook: DocSpring sends a POST request to the URL for each event, signed with the webhook's secret. A webhook's signing secret and its headers' values aren't shown to assistants: the user copies the secret from the webhook's page in DocSpring (Webhooks, in the sidebar), and adds headers there.
create_word_template
ChatGPTCreates a Word template from a Word document (.docx, or an OpenDocument text file, .odt, which DocSpring converts to one) with tags where the data goes, such as {{ customer.name }}, {% for item in line_items %}...{% endfor %}, {% if %} and {% image logo %}, and waits until DocSpring has it. DocSpring adds a field for each value the tags use: get_template shows them, and update_fields sets their types and which are required. Give the document as a link, as base64, or (for a file on disk) upload it with create_pdf_upload first. output_format chooses what each submission makes: a Word document (docx), an OpenDocument file (odt) or a PDF. A tag that can't be used (an unclosed tag, an {% endfor %} without its {% for %}) makes submissions fail: check the template with preview_template. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees.
customize_email_action
ChatGPTChanges an account email action for one template only, or turns it off for that template, replacing the template's earlier changes.
delete_email_action
ChatGPTDeletes an email action. Its emails stop at once, including ones waiting to be sent.
delete_email_domain
ChatGPTRemoves an email domain. Email actions that send from an address at it fail until it's added and verified again, or their from_address changes.
delete_folder
ChatGPTDeletes an empty template folder. A folder with templates or folders in it can't be deleted.
delete_template
ChatGPTDeletes a template: its draft and every published version. Submissions, forms and signature requests can't use it afterwards, though its existing submissions stay. It can't be undone, so confirm with the user first, naming the template. A locked template can't be deleted.
delete_version
ChatGPTDeletes one published version of a template. Submissions that ask for it fail afterwards. The template, its draft and its other versions stay. It can't be undone.
delete_webhook
ChatGPTDeletes a webhook. Its events stop at once.
diff_versions
ChatGPTShows what changed in a template's draft since its latest published version (or in a published version since the one before it): fields added, removed, changed and moved, settings, and whether the PDF or Word document was replaced. Added and removed fields show their main settings (get_fields shows the rest), and changed fields the settings that changed. Check it before publish_version.
expire_submission
ChatGPTExpires a submission now: deletes its data (the field values), its metadata, its PDF, its error messages and the IP address and browser it was submitted from. Its ID, state, template, test or live, times, audit trail and signature requests stay. A submission that's waiting for signatures keeps waiting: expiring it doesn't cancel its signature requests. It can't be undone.
generate_pdf
ChatGPTFills in a template with data and makes a submission: a PDF, or a Word template's Word document (its output_format), and waits for it. Give the user the file's link, files.pdf.download_url (files.docx.download_url for a Word document, files.odt.download_url for an OpenDocument file), and say it works for 24 hours: get_submission returns a new one. Use test: true unless the user wants a real document: live documents use credits.
generate_pdfs
ChatGPTMakes up to 50 submissions in one batch (PDFs, or Word templates' Word documents or OpenDocument files), from one template or several, and waits for them. Each submission's files.pdf.download_url (files.docx.download_url for a Word document, files.odt.download_url for an OpenDocument file) works for 24 hours. Use test: true unless the user wants real documents: live documents use credits.
generate_submission_files
ChatGPTMakes the other files of a Word template's submission, and waits for them: its PDF, Word document or OpenDocument file (odt) when it didn't make them. They don't use credits again. Returns the submission with the new files' download_url, which works for 24 hours. get_submission_pages shows the PDF's pages.
get_fields
ChatGPTGets the settings of a template's fields, or of the fields chosen by ID or name. Settings at their default values are left out (include_defaults shows them), except required, which is true by default. Positions are in units where every page is 2480 wide, measured from the page's top left corner. An HTML or Word template's or a page design's fields have no position: they only define its data.
get_model_code
ChatGPTGenerates types for a template's submission data, for code that creates submissions with DocSpring's API or SDKs: the types only, without code to convert JSON (the API's just_types option).
get_submission
ChatGPTGets a submission (its state, data, signature requests and links to download its files), a batch from generate_pdfs, or a combined PDF from combine_pdfs. While it's still being processed, it waits for it (up to 50 seconds). Download links expire: get_submission again for new ones. get_submission_pages shows its pages.
get_submission_pages
ChatGPTShows a submission's PDF as page images, to check how the data looks on it. The first time, DocSpring makes the images, which takes a few seconds: for a Word template's submission that made no PDF (only its Word document or OpenDocument file), it makes the PDF first, without using credits again.
get_template
ChatGPTGets a template: its settings, a summary of each field (name, type, description, and on a PDF template its page and position), and for the draft, whether it has changes that aren't published yet. While a new PDF is still being processed, or a document_url downloaded, it waits for it (up to 50 seconds). Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. get_fields shows every setting of chosen fields, and list_versions the published versions.
get_template_pages
ChatGPTShows a PDF template's pages as images, to see where fields go. Each image is 992 pixels wide, and field positions are in units where every page is 2480 wide, so a field's x, y, width and height are the image's pixels times 2.5. HTML and Word templates and page designs have no page images: preview_template shows their pages filled in with data.
get_template_schema
ChatGPTGets the JSON Schema of the data a template's submissions take: each field's name, type, and whether it's required.
list_email_actions
ChatGPTLists the account's email actions, which email each submission's files to people once it's processed, 50 at a time. With template_id, lists the template's own and the account email actions that send for it.
list_email_domains
ChatGPTLists the domains email actions can send from once they're verified, with the DNS records each one needs, 50 at a time.
list_folders
ChatGPTLists the account's template folders, with each one's path, 50 at a time.
list_submissions
ChatGPTLists the account's submissions, newest first, 50 at a time: each one's state, template, test or live, metadata and times. Its data and files are left out unless you ask for them. get_submission has a submission's signature requests, and get_submission_pages its pages.
list_templates
ChatGPTLists the account's templates, 50 at a time: each one's name, type, folder, latest published version and whether it's ready. A template is a PDF, HTML or Word document, or a page design, with fields that DocSpring fills in with submission data. get_template has a template's settings and fields.
list_versions
ChatGPTLists a template's published versions, newest first (up to 100), with who published each one and what changed.
list_webhooks
ChatGPTLists the account's webhooks. A webhook's signing secret and its headers' values aren't shown to assistants: the user copies the secret from the webhook's page in DocSpring (Webhooks, in the sidebar), and adds headers there.
move_folder
ChatGPTMoves a template folder, with everything in it, into another folder or to the root.
move_template
ChatGPTMoves a template, with all of its published versions, to a folder or to the root.
preview_template
ChatGPTShows a template's pages filled in with your data as PNG images (not a PDF), to check how an HTML, PDF or Word template or a page design prints before you publish it or generate live documents (a Word template's pages are its PDF's). It makes no submission and uses no credits, and the pages are watermarked like a test PDF's. Renders the draft by default, so you can check a change before you publish it. The data isn't checked against the template's fields (validate_data does that), and a value a field can't print is an error. Unlike a submission, an HTML template's preview stops with an error at an undefined variable or an unknown filter, so send a value for every key the template prints.
publish_version
ChatGPTPublishes a template's draft as a new version, which new submissions use straight away. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. Before asking, check the changes with diff_versions and preview_template, which shows the draft's pages filled in with data.
remove_fields
ChatGPTRemoves fields from a template's draft. Published versions keep them. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees.
rename_folder
ChatGPTRenames a template folder.
replace_template_pdf
ChatGPTReplaces a PDF template's PDF, or a Word template's Word document (.docx or .odt), in its draft, and waits until DocSpring has processed it. The fields stay: reimport_fields replaces a PDF template's fields with the new PDF's form fields, and a Word template adds a field for each new tag. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees.
reset_email_action_customization
ChatGPTRemoves a template's changes to an account email action, so it sends for that template as it is.
restore_version
ChatGPTReplaces a template's draft with a published version. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. So restoring a version doesn't change what submissions get: to roll back, publish the restored draft with publish_version. Changes in the draft that aren't published are lost, so it refuses while the draft has any, unless discard_draft_changes is set.
send_test_email
ChatGPTSends an email action's email to the user only, with each field shown as its name in brackets and, for a PDF template, its blank PDF, so they can check how it looks.
support_get_help
ChatGPTAsk a question about DocSpring and get an answer from its documentation and known issues: how to do something, what an error means, whether a problem is already known. Call this first when a tool fails or you are not sure how to do what the user asked. It opens no ticket, so you do not need to ask the user first. Never include secrets, credentials or the user's data. If the answer doesn't solve the problem, send it with support_send_feedback, or if the user is blocked, tell them and offer to open a ticket with support_open_ticket.
support_list_tickets
ChatGPTList this account's DocSpring support tickets, newest first. unread_count shows which have replies from the team that nobody on this account has read yet, including replies on tickets the team has resolved. The list covers every agent working for this account: pass session to see only the tickets opened with your label.
support_open_ticket
ChatGPTOpen a support ticket with the DocSpring team when the user is blocked, got a wrong result or needs an answer: a bug, a crash, a wrong result, a missing feature or a question. A person on the team reads every ticket and replies. For something that only got in the way, use support_send_feedback instead. If the user asked you to open this, set source to user: they have already agreed. Otherwise, before calling this, tell the user what happened, show them every piece of text you would send, and get their yes. Only for DocSpring itself, not for other tools or services. One ticket per distinct problem. Never include secrets, credentials or the user's data. The team replies on the ticket: read replies with support_get_ticket. If this call fails, carry on with the task and do not retry. Afterwards, tell the user how the reply will arrive.
support_reply_to_ticket
ChatGPTAdd a message to one of this account's DocSpring support tickets: an answer to the team's question, more detail, or whether their fix worked. Show the user the message and get their yes before calling this. Set outcome to still_broken to reopen a resolved ticket. Never include secrets, credentials or the user's data.
support_send_feedback
ChatGPTTell the DocSpring team about something that got in your way while the work still got done: a confusing tool or error, a missing feature, wrong documentation, a bug you worked around, or an idea. Nobody replies to feedback. Send it without asking the user, at most once per distinct problem, and tell the user afterwards what you sent. If the user is blocked or needs an answer, use support_open_ticket instead. Only for DocSpring itself, not for other tools or services. Never include secrets, credentials or the user's data. If this call fails, carry on with the task and do not retry.
update_email_action
ChatGPTChanges an email action. To change an account email action for one template only, use customize_email_action.
update_fields
ChatGPTChanges fields of a template's draft: their settings, names, and on a PDF template their pages or positions. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. Returns the fields it changed.
update_page_design
ChatGPTReplaces a page design's layout in its draft: get_template returns the current layout to change. DocSpring adds a field for each new value the layout reads, and keeps the fields it no longer reads (remove_fields removes them). A layout with problems isn't saved, and the error lists each one by its JSON path. Check how it prints with preview_template. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. Returns a summary of the template.
update_template
ChatGPTChanges a template's settings in its draft. Until a template's first publish_version, submissions use its draft. After that they use the latest published version (unless they ask for another), so changes to the draft reach them only once publish_version publishes them. Publish only when the user agrees. The template's own settings are the exception: they apply to every version as soon as they're saved. They include expire_submissions, public_web_form, public_submissions, redirect_url, encrypt_pdfs, embed_domains, locked and a Word template's output_format. Returns a summary of the template.
update_webhook
ChatGPTChanges a webhook: its URL, events, filters, or whether it's enabled.
validate_data
ChatGPTChecks submission data against a template without making a PDF or saving anything: which fields are missing or have the wrong type.
verify_email_domain
ChatGPTChecks an email domain's DNS records now, instead of waiting for the next check.
add_email_domain
Claudeadd_fields
Claudecombine_pdfs
Claudecopy_template
Claudecreate_email_action
Claudecreate_folder
Claudecreate_html_template
Claudecreate_page_design
Claudecreate_pdf_template
Claudecreate_pdf_upload
Claudecreate_signature_request
Claudecreate_signing_link
Claudecreate_webhook
Claudecreate_word_template
Claudecustomize_email_action
Claudedelete_email_action
Claudedelete_email_domain
Claudedelete_folder
Claudedelete_template
Claudedelete_version
Claudedelete_webhook
Claudediff_versions
Claudeexpire_submission
Claudegenerate_pdf
Claudegenerate_pdfs
Claudegenerate_submission_files
Claudeget_fields
Claudeget_model_code
Claudeget_submission
Claudeget_submission_pages
Claudeget_template
Claudeget_template_pages
Claudeget_template_schema
Claudelist_email_actions
Claudelist_email_domains
Claudelist_folders
Claudelist_submissions
Claudelist_templates
Claudelist_versions
Claudelist_webhooks
Claudemove_folder
Claudemove_template
Claudepreview_template
Claudepublish_version
Clauderemove_fields
Clauderename_folder
Claudereplace_template_pdf
Claudereset_email_action_customization
Clauderestore_version
Claudesend_test_email
Claudeupdate_email_action
Claudeupdate_fields
Claudeupdate_page_design
Claudeupdate_template
Claudeupdate_webhook
Claudevalidate_data
Claudeverify_email_domain
Claude