{"openapi":"3.1.0","info":{"title":"DocuSeal (BYOK) API","version":"0.1.0","description":"DocuSeal (BYOK) lets an AI assistant read your own DocuSeal data through the DocuSeal API with a key you supply (DocuSeal API key). Read-only: 6 tools (list_templates, get_template, list_submissions, get_submission, get_submission_documents, list_submitters). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-docuseal.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-docuseal/docs"},"termsOfService":"https://connectorbay.com/byok-docuseal/terms"},"servers":[{"url":"https://byok-docuseal.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-docuseal/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_templates":{"post":{"operationId":"list_templates","summary":"List document templates with name, folder, external ID, author and dates; filter by name, folder or archive state. Retur","description":"List document templates with name, folder, external ID, author and dates; filter by name, folder or archive state. Returns 10 by default, up to 100 per page. Use for \"Which DocuSeal templates do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Which DocuSeal cloud your account is on: 'com' for api.docuseal.com (US) or 'eu' for api.docuseal.eu (EU). Self-hosted installs are not supported.","enum":["com","eu"],"title":"Region","type":"string"},"q":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Partial template name to search for.","title":"Q"},"folder":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only templates in this folder name.","title":"Folder"},"external_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only templates with this application-specific external ID.","title":"External Id"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list archived templates instead of active ones.","title":"Archived"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many templates to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Return only templates with an ID greater than this value; pass pagination.next from the previous answer.","title":"After"},"before":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Return only templates with an ID lower than this value.","title":"Before"}},"required":["region"],"title":"list_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_template":{"post":{"operationId":"get_template","summary":"Get one template: name, folder, signer roles (submitters), fields and document file names. Use for \"What fields and sign","description":"Get one template: name, folder, signer roles (submitters), fields and document file names. Use for \"What fields and signer roles does DocuSeal template 1000001 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Which DocuSeal cloud your account is on: 'com' for api.docuseal.com (US) or 'eu' for api.docuseal.eu (EU). Self-hosted installs are not supported.","enum":["com","eu"],"title":"Region","type":"string"},"id":{"description":"DocuSeal template ID (a number from list_templates).","minimum":1,"title":"Id","type":"integer"}},"required":["region","id"],"title":"get_templateArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_submissions":{"post":{"operationId":"list_submissions","summary":"List signature requests (submissions) with status, template, creation and completion times; filter by status, template o","description":"List signature requests (submissions) with status, template, creation and completion times; filter by status, template or folder. Signer names and emails are not returned. Use for \"Which DocuSeal signature requests are still pending\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Which DocuSeal cloud your account is on: 'com' for api.docuseal.com (US) or 'eu' for api.docuseal.eu (EU). Self-hosted installs are not supported.","enum":["com","eu"],"title":"Region","type":"string"},"template_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only submissions created from this template ID.","title":"Template Id"},"status":{"anyOf":[{"enum":["completed","declined","expired","pending"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by status: completed, declined, expired or pending.","title":"Status"},"template_folder":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only submissions of templates in this folder name.","title":"Template Folder"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for archived submissions only, false for active ones.","title":"Archived"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many submissions to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Return only submissions with an ID greater than this value; pass pagination.next from the previous answer.","title":"After"},"before":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Return only submissions with an ID lower than this value.","title":"Before"}},"required":["region"],"title":"list_submissionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_submission":{"post":{"operationId":"get_submission","summary":"Get one submission: overall status, template, timeline events (viewed, started, completed) and signed document links. Si","description":"Get one submission: overall status, template, timeline events (viewed, started, completed) and signed document links. Signer identities and form values are not returned. Use for \"What is the status and event history of DocuSeal submission 1001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Which DocuSeal cloud your account is on: 'com' for api.docuseal.com (US) or 'eu' for api.docuseal.eu (EU). Self-hosted installs are not supported.","enum":["com","eu"],"title":"Region","type":"string"},"id":{"description":"DocuSeal submission ID (a number from list_submissions).","minimum":1,"title":"Id","type":"integer"}},"required":["region","id"],"title":"get_submissionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_submission_documents":{"post":{"operationId":"get_submission_documents","summary":"List the document files of a submission (the signed PDFs once completed, otherwise partially filled copies) with file na","description":"List the document files of a submission (the signed PDFs once completed, otherwise partially filled copies) with file name and download link. Use for \"Where can I download the signed documents of DocuSeal submission 1001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Which DocuSeal cloud your account is on: 'com' for api.docuseal.com (US) or 'eu' for api.docuseal.eu (EU). Self-hosted installs are not supported.","enum":["com","eu"],"title":"Region","type":"string"},"id":{"description":"DocuSeal submission ID (a number from list_submissions).","minimum":1,"title":"Id","type":"integer"},"merge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to merge all documents into a single PDF.","title":"Merge"}},"required":["region","id"],"title":"get_submission_documentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_submitters":{"post":{"operationId":"list_submitters","summary":"List individual signing parties and their progress (status, sent, opened, completed and declined times) without names, e","description":"List individual signing parties and their progress (status, sent, opened, completed and declined times) without names, emails or phone numbers. Use for \"Who has not yet completed signing in DocuSeal\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Which DocuSeal cloud your account is on: 'com' for api.docuseal.com (US) or 'eu' for api.docuseal.eu (EU). Self-hosted installs are not supported.","enum":["com","eu"],"title":"Region","type":"string"},"submission_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only submitters of this submission ID.","title":"Submission Id"},"completed_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only submitters who completed after this time, for example 2026-01-01 00:00:00.","title":"Completed After"},"completed_before":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only submitters who completed before this time.","title":"Completed Before"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many submitters to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Return only submitters with an ID greater than this value; pass pagination.next from the previous answer.","title":"After"},"before":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Return only submitters with an ID lower than this value.","title":"Before"}},"required":["region"],"title":"list_submittersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}