{"openapi":"3.1.0","info":{"title":"Documenso (BYOK) API","version":"0.1.0","description":"Documenso (BYOK) lets an AI assistant read your own Documenso data through the Documenso API with a key you supply (API token). Read-only: 7 tools (list_envelopes, list_completed_documents, find_templates, list_expired_envelopes, get_envelope, list_folders, list_envelope_attachments). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-documenso.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-documenso/docs"},"termsOfService":"https://connectorbay.com/byok-documenso/terms"},"servers":[{"url":"https://byok-documenso.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-documenso/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_envelopes":{"post":{"operationId":"list_envelopes","summary":"List documents and templates (envelopes) of the token's team, newest first, with title, status, creator and dates. Filte","description":"List documents and templates (envelopes) of the token's team, newest first, with title, status, creator and dates. Filter by status, type, source, template or folder. Use for \"Which Documenso documents are still pending signatures\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Words to search for in the title.","title":"Query"},"status":{"anyOf":[{"enum":["DRAFT","PENDING","COMPLETED","REJECTED","CANCELLED"],"type":"string"},{"type":"null"}],"default":null,"description":"Only envelopes in this status.","title":"Status"},"type":{"anyOf":[{"enum":["DOCUMENT","TEMPLATE"],"type":"string"},{"type":"null"}],"default":null,"description":"DOCUMENT or TEMPLATE.","title":"Type"},"source":{"anyOf":[{"enum":["DOCUMENT","TEMPLATE","TEMPLATE_DIRECT_LINK"],"type":"string"},{"type":"null"}],"default":null,"description":"How the envelope was created.","title":"Source"},"template_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only documents created from the template with this numeric ID.","title":"Template Id"},"folder_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in the folder with this ID (from list_folders).","title":"Folder Id"},"order_direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort by creation date: asc or desc.","title":"Order Direction"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_envelopesArguments","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_completed_documents":{"post":{"operationId":"list_completed_documents","summary":"List documents that all recipients have signed (status COMPLETED), newest first, with title, creator and completion date","description":"List documents that all recipients have signed (status COMPLETED), newest first, with title, creator and completion date. Use for \"Which Documenso documents were fully signed recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Words to search for in the title.","title":"Query"},"status":{"anyOf":[{"enum":["COMPLETED","REJECTED","CANCELLED"],"type":"string"},{"type":"null"}],"default":"COMPLETED","description":"Envelope status; COMPLETED unless you change it.","title":"Status"},"type":{"anyOf":[{"const":"DOCUMENT","type":"string"},{"type":"null"}],"default":"DOCUMENT","description":"Fixed to DOCUMENT.","title":"Type"},"folder_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in the folder with this ID (from list_folders).","title":"Folder Id"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_completed_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/find_templates":{"post":{"operationId":"find_templates","summary":"List or search your Documenso templates (envelopes of type TEMPLATE) with title, creator and dates. Use for \"What Docume","description":"List or search your Documenso templates (envelopes of type TEMPLATE) with title, creator and dates. Use for \"What Documenso templates do we have for contracts\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Words to search for in the title.","title":"Query"},"type":{"anyOf":[{"const":"TEMPLATE","type":"string"},{"type":"null"}],"default":"TEMPLATE","description":"Fixed to TEMPLATE.","title":"Type"},"folder_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in the folder with this ID (from list_folders).","title":"Folder Id"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"find_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/list_expired_envelopes":{"post":{"operationId":"list_expired_envelopes","summary":"List envelopes where at least one recipient's signing link has expired, so they need to be re-sent. Use for \"Which Docum","description":"List envelopes where at least one recipient's signing link has expired, so they need to be re-sent. Use for \"Which Documenso documents have recipients with expired signing links\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"has_expired_recipients":{"anyOf":[{"enum":["true","false"],"type":"string"},{"type":"null"}],"default":"true","description":"'true' to list envelopes with an expired recipient, 'false' for those without.","title":"Has Expired Recipients"},"status":{"anyOf":[{"enum":["DRAFT","PENDING","COMPLETED","REJECTED","CANCELLED"],"type":"string"},{"type":"null"}],"default":"PENDING","description":"Only envelopes in this status.","title":"Status"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_expired_envelopesArguments","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_envelope":{"post":{"operationId":"get_envelope","summary":"Get one envelope: title, status, type, dates, folder, visibility and delivery settings such as subject, message, signing","description":"Get one envelope: title, status, type, dates, folder, visibility and delivery settings such as subject, message, signing order and language. Use for \"Show the details of Documenso envelope envelope_abcd1234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"envelope_id":{"description":"Envelope ID as returned by list_envelopes (id), for example 'envelope_abcd1234'.","maxLength":80,"title":"Envelope Id","type":"string"}},"required":["envelope_id"],"title":"get_envelopeArguments","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_folders":{"post":{"operationId":"list_folders","summary":"List Documenso folders for documents or templates with name, parent, pinned flag and dates. Use for \"What folders exist ","description":"List Documenso folders for documents or templates with name, parent, pinned flag and dates. Use for \"What folders exist in Documenso\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Words to search for in the title.","title":"Query"},"type":{"anyOf":[{"enum":["DOCUMENT","TEMPLATE"],"type":"string"},{"type":"null"}],"default":null,"description":"Folder kind: DOCUMENT or TEMPLATE.","title":"Type"},"parent_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only sub-folders of this folder ID.","title":"Parent Id"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_foldersArguments","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_envelope_attachments":{"post":{"operationId":"list_envelope_attachments","summary":"List the attachments (links) added to an envelope with label and URL. Use for \"What attachments does Documenso envelope ","description":"List the attachments (links) added to an envelope with label and URL. Use for \"What attachments does Documenso envelope envelope_abcd1234 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"envelope_id":{"description":"Envelope ID as returned by list_envelopes (id).","maxLength":80,"title":"Envelope Id","type":"string"}},"required":["envelope_id"],"title":"list_envelope_attachmentsArguments","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}}}}