cancel_envelope
ChatGPTCancel an in-progress SignatureAPI envelope. The envelope transitions to canceled. Pending recipients won't be able to access the ceremonies. Already-completed envelopes cannot be canceled (the api returns 409). If the user wants to undo a completed envelope, you must explain that signed envelopes are immutable.
create_ceremony
ChatGPTCreate a new signing ceremony for a recipient, revoking any previous active one. Use it to switch a recipient's authentication (email_link, email_code, custom), to embed the ceremony in your own site (embeddable_in, with custom authentication), or to set a redirect_url after completion. The response includes ceremony settings but omits authentication evidence: url is present for custom and email_code authentication and null for email_link — for email_link the link is delivered by email and possession of that email is the recipient's authentication, so it is never disclosed here (in test mode read it through get_email). Creating a ceremony may email the recipient in live mode.
create_envelope
ChatGPTCreate a new SignatureAPI envelope. At minimum you must provide title, documents, and recipients. Documents reference uploads created via upload_file. If required information (e.g. recipient name/email) is missing from the user, ask before calling. Use only non-sensitive data that is necessary for the requested e-signature workflow. The envelope is created in test mode unless mode: "live" is passed — live mode emails real people, so never pass it without the user's explicit intent.
create_webhook
ChatGPTSubscribe a user-authorized HTTPS endpoint to SignatureAPI events. Future matching events are sent to that endpoint. Returns the endpoint and signing_secret_dashboard_url for the user's credential management outside the conversation. Credentials — API keys and webhook signing secrets — are never returned by a tool; never ask them to paste it into the chat. Deliveries follow the Standard Webhooks spec: verify the webhook-id, webhook-timestamp and webhook-signature headers with the secret (search_documentation for 'verify webhook signature'). Omit event_types to receive every event; topics limits deliveries to envelopes carrying one of those topics. list_webhook_attempts reports delivery results. Create a test envelope to exercise the endpoint only when that test is part of the user's request.
delete_envelope
ChatGPTPermanently delete a SignatureAPI envelope and its associated data. This is irreversible — CONFIRM with the user before calling, and prefer cancel_envelope if the envelope is in progress. Returns deleted: true and the envelope identifier on success.
delete_webhook
ChatGPTUnsubscribe and permanently delete a webhook endpoint in the given mode. Pending deliveries to it are dropped. Cannot be undone — create_webhook again if needed.
get_deliverables
ChatGPTReturn every deliverable of an envelope with a fresh download url. A deliverable is the signed PDF (documents plus, by default, the audit log) produced when the envelope completes; each has a status — pending or processing while the envelope is not yet complete, generated when url is a pre-signed download link valid for about one hour, failed on a rare generation error. Call it after envelope.completed / deliverable.generated (see list_events). Call it again whenever a url has expired — every call re-fetches each deliverable, so the links are always fresh.
get_email
ChatGPTFetch a single SignatureAPI email by id (eml_…, from list_emails), including delivery details. Only test-mode signing-request emails include a short-lived html_url and extracted ceremony_url; live email content and authentication-code content are not returned. This is how an agent reaches an email_link ceremony in test mode: list_emails for the envelope, pick the request-type email, then use this tool's ceremony_url. For live-mode emails ceremony_url is always null — possession of the emailed link is the recipient's authentication, so live links are never disclosed.
get_envelope
ChatGPTFetch a SignatureAPI envelope by id.
inspect_upload
ChatGPTReturn the analyzed structure of an uploaded PDF or DOCX: format, page_count, pages[] with each page's width/height, the [[key]] placeholders[] detected (with page_number, left, top, width, height and any errors), and for DOCX the {{key}} template fields[]. Coordinates and sizes are PDF points (1/72 inch) with the origin at the TOP-LEFT of the page — the same units and origin create_envelope uses for fixed_positions (top, left) and place sizes. Use this before create_envelope to confirm the page count, pick page/top/left for fixed positions, and check that every placeholder key you rely on was detected.
list_emails
ChatGPTList the emails SignatureAPI generated for the authenticated account, most-recent first, with cursor pagination. Covers signing-request emails, deliverable emails, OTP codes and owner notifications — in both live and test mode. In test mode emails are never actually sent; they are recorded here instead. Use this after creating a test-mode envelope to find the signing-request email (type: "request") for a recipient, then call get_email to obtain its ceremony link. Also useful for deliverability questions (status, delivered_at, bounced_at). Returns data (array of emails) and links.next / links.previous (opaque cursor URLs — extract the cursor query param to paginate).
list_envelopes
ChatGPTList envelopes for the authenticated account in one mode (test by default), most-recent first, with cursor pagination. Use this to discover existing envelopes before asking the user for an id, to check whether an envelope you'd be about to create already exists, or to answer 'what envelopes do I have?' style questions. Returns a paginated response with data (array of envelopes) and links.next / links.previous (opaque cursor URLs — extract the cursor query param to paginate).
list_events
ChatGPTList SignatureAPI events, newest first: for the whole account, for one envelope (envelope_id) or for one recipient (recipient_id). Each event has id, type (e.g. envelope.created, recipient.completed, deliverable.generated), timestamp and a data payload containing resource correlation fields only (no authentication evidence or envelope metadata). This is how you verify that something happened. wait_seconds (0–20) turns the call into a wait: the server re-reads the listing every 2 seconds until an event newer than the first page appears, then returns. If nothing new arrives before the deadline the current page is returned with timed_out: true — that is not an error, call again to keep waiting. Use it right after an action (create_envelope, resend_request, a signer finishing) instead of sleeping and polling yourself. Paginate with cursor taken from links.next.
list_webhook_attempts
ChatGPTList the most recent delivery attempts made to a webhook endpoint, newest first: message id, event type, event id, delivery status (success, pending, fail, sending), the endpoint's HTTP status code and response time. Destination response bodies are omitted. This is how to confirm a webhook arrived after an event on an envelope. Failed deliveries are retried automatically for about a day; a persistent fail with a 4xx/5xx response_status_code points at the endpoint. Paginate with cursor from next_cursor.
list_webhooks
ChatGPTList the webhook endpoints subscribed for the authenticated account in one mode (test or live). Each endpoint shows its URL, the event types it receives (null = all), the envelope topics it is limited to (null = all) and whether it is disabled. Webhooks are configured separately per mode: an endpoint created in test mode only receives events from test-mode envelopes. Use this before create_webhook to avoid duplicates, and to find the id for update_webhook, list_webhook_attempts and delete_webhook.
mint_upload_url
ChatGPTMint a short-lived signed upload URL for agents that can PUT local bytes themselves. This tool does NOT transfer bytes — it returns a upload_url (single-use, ~5 min) and the canonical reference you'll later pass to create_envelope. REQUIRED SEQUENCE (do all three in order): 1. Compute the file's exact size in bytes and SHA-256 hash BEFORE calling this tool. The values are bound into the upload URL's signature, so they must match the bytes you actually send. - size: byte count of the file (e.g. wc -c < path or stat). - sha256: 64 lowercase hex chars (e.g. shasum -a 256 path | awk '{print $1}'). 2. Call this tool with media_type, size, sha256. You get back upload_url and reference. 3. PUT the raw file bytes to upload_url. Three headers are REQUIRED and must all match what you declared in step 1: - Content-Type: <media_type> - Content-Length: <size> - x-amz-content-sha256: <sha256> Example: curl -sS -X PUT '<upload_url>' -H 'Content-Type: <media_type>' -H 'Content-Length: <size>' -H 'x-amz-content-sha256: <sha256>' --data-binary @<path> On a 2xx PUT, the upload is registered server-side and reference becomes resolvable. Pass reference (a https://api.signatureapi.com/v1/uploads/upl_… URL) to create_envelope as the document URL — do NOT pass upload_url. If the PUT returns 4xx, the bytes never reached storage. Re-mint by calling mint_upload_url again — the URL is single-use. NO LOCAL CODE EXECUTION? If you cannot run a PUT (e.g. you are a pure connector client like Claude.ai with no shell), do NOT call this tool. Ask the user to upload the file via their SignatureAPI dashboard or supply a URL on an already-allowlisted host (S3, Google Drive, Dropbox, Bubble, etc.) and pass that URL directly to create_envelope.
replace_recipient
ChatGPTReplace a recipient with a different person. The original recipient becomes replaced; a new recipient is created with the given email and name and inherits the original's type, key, routing position and places. Allowed while the recipient has not completed and the envelope is processing or in_progress. Use it after a hard bounce or when the wrong person was assigned. In live mode the new person is emailed — confirm with the user first.
resend_request
ChatGPTResend the signing-request email to a recipient who has not completed yet. Allowed while the recipient is sent or soft_bounced and the envelope is in_progress. Optionally override the subject and message for this one email. Returns can_resend_at: the next resend is refused before that time. In live mode this emails a real person — confirm with the user first. In test mode nothing is sent; the email is recorded and readable through list_emails / get_email.
search_documentation
ChatGPTSearch the public SignatureAPI documentation and return ranked excerpts with source URLs — or, with page, read one documentation page in full. Use this BEFORE create_envelope (or any envelope-shape question) whenever you're unsure about: field names, accepted enum values, recipient/document/place schemas, supported file formats, webhook events, authentication, embedded signing, or any concept-level question (test mode, deliverables, ceremonies, attestation, etc.). It is cheaper to search than to guess and have the envelope rejected. Two modes: (1) query returns up to max_results results, each with a title, url and short snippet; (2) page (a docs slug such as docs/api/webhooks, taken from a result's url) returns that page's complete Markdown in page.markdown and ignores query. Search first, then read the page whose excerpt looks right. Cite the url back to the user when explaining how something works.
update_webhook
ChatGPTChange a webhook endpoint in place: its url, description, the event_types it receives, the envelope topics it is limited to, or pause/resume it with disabled. Only the fields you pass change; pass null for event_types or topics to remove that filter (deliver everything). The signing secret is unchanged and is not returned. Repeating the same call is a no-op. Changing url redirects customer traffic, so confirm with the user; prefer disabled: true over delete_webhook when an endpoint should merely stop receiving events for a while.
upload_file
ChatGPTUpload a file provided by ChatGPT Apps file handling into SignatureAPI. Use this when the user has uploaded or selected a PDF, DOCX, or PNG in ChatGPT and wants to use it as a SignatureAPI document, template, logo, or symbol asset. The file input is a ChatGPT file parameter; do not invent URLs. Let ChatGPT populate it from the user's uploaded or selected file. Returns a SignatureAPI upload URL. Pass url as document.url in create_envelope.
whoami
ChatGPTReturn the connected SignatureAPI account name and available test/live modes. Use only when the user asks which account is connected or when you need to check live-mode access for their requested action. Does not return the user's email, user ID, or credentials.