{"openapi":"3.1.0","info":{"title":"SignatureAPI (BYOK) API","version":"0.1.0","description":"SignatureAPI (BYOK) lets an AI assistant read your own SignatureAPI data through the SignatureAPI API with a key you supply (SignatureAPI API key (Dashboard > API keys; test or live)). Read-only: 8 tools (list_envelopes, get_envelope, list_events, list_envelope_events, list_envelope_deliverables, get_deliverable, get_upload, get_upload_structure). The BYOK key travels with each request, is used...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-signatureapi.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-signatureapi/docs"},"termsOfService":"https://connectorbay.com/byok-signatureapi/terms"},"servers":[{"url":"https://byok-signatureapi.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-signatureapi/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 envelopes newest first with status, mode, routing, language, topics and created and completed times (documents, rec","description":"List envelopes newest first with status, mode, routing, language, topics and created and completed times (documents, recipients and sender details are not returned). Use for \"Which SignatureAPI envelopes are still in progress\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["processing","in_progress","completed","failed","canceled"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by envelope status.","title":"Status"},"topic":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by envelope topic tag.","title":"Topic"},"limit":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Maximum number of objects to return (1 to 20).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor, copied from the cursor value inside the links.next URL of the previous page.","title":"Cursor"}},"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/get_envelope":{"post":{"operationId":"get_envelope","summary":"Get one envelope's status, mode, routing, language, topics and created and completed times (documents, recipients and se","description":"Get one envelope's status, mode, routing, language, topics and created and completed times (documents, recipients and sender details are not returned). Use for \"What is the status of SignatureAPI envelope env_3Xk9aBcD\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"envelope_id":{"description":"Envelope id, as returned by list_envelopes.","maxLength":200,"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_events":{"post":{"operationId":"list_events","summary":"List account-wide events newest first (envelope, recipient and deliverable lifecycle) with type, timestamp and object id","description":"List account-wide events newest first (envelope, recipient and deliverable lifecycle) with type, timestamp and object ids; envelope metadata is not returned. Use for \"What happened recently in my SignatureAPI account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by event type, for example envelope.completed or recipient.hard_bounced.","title":"Type"},"limit":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Maximum number of objects to return (1 to 20).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor, copied from the cursor value inside the links.next URL of the previous page.","title":"Cursor"}},"title":"list_eventsArguments","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_events":{"post":{"operationId":"list_envelope_events","summary":"List the events of one envelope newest first with type, timestamp and object ids. Use for \"What is the event history of ","description":"List the events of one envelope newest first with type, timestamp and object ids. Use for \"What is the event history of SignatureAPI envelope env_3Xk9aBcD\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"envelope_id":{"description":"Envelope id, as returned by list_envelopes.","maxLength":200,"title":"Envelope Id","type":"string"},"type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by event type, for example recipient.completed.","title":"Type"},"limit":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Maximum number of objects to return (1 to 20).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor, copied from the cursor value inside the links.next URL of the previous page.","title":"Cursor"}},"required":["envelope_id"],"title":"list_envelope_eventsArguments","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_deliverables":{"post":{"operationId":"list_envelope_deliverables","summary":"List the deliverables (signed PDF outputs) of one envelope with type, status, language and generation times (download UR","description":"List the deliverables (signed PDF outputs) of one envelope with type, status, language and generation times (download URLs and passwords are not returned). Use for \"Has the signed PDF of SignatureAPI envelope env_3Xk9aBcD been generated\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"envelope_id":{"description":"Envelope id, as returned by list_envelopes.","maxLength":200,"title":"Envelope Id","type":"string"},"limit":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Maximum number of objects to return (1 to 20).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor, copied from the cursor value inside the links.next URL of the previous page.","title":"Cursor"}},"required":["envelope_id"],"title":"list_envelope_deliverablesArguments","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_deliverable":{"post":{"operationId":"get_deliverable","summary":"Get one deliverable's type, status, language and generation times (the download URL and password are not returned). Use ","description":"Get one deliverable's type, status, language and generation times (the download URL and password are not returned). Use for \"What is the status of SignatureAPI deliverable del_5TgH7wQe\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deliverable_id":{"description":"Deliverable id, as returned by list_envelope_deliverables.","maxLength":200,"title":"Deliverable Id","type":"string"}},"required":["deliverable_id"],"title":"get_deliverableArguments","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_upload":{"post":{"operationId":"get_upload","summary":"Get an uploaded file's retention type, permanent key, format, size and timestamps (the internal URL is not returned). Us","description":"Get an uploaded file's retention type, permanent key, format, size and timestamps (the internal URL is not returned). Use for \"What are the details of SignatureAPI upload upl_1AbC2dEf\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"upload_id":{"description":"Upload id, for example upl_1AbC2dEf.","maxLength":200,"title":"Upload Id","type":"string"}},"required":["upload_id"],"title":"get_uploadArguments","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_upload_structure":{"post":{"operationId":"get_upload_structure","summary":"Get the analyzed structure of an uploaded file: format, page count and detected placeholder keys. Use for \"Which placeho","description":"Get the analyzed structure of an uploaded file: format, page count and detected placeholder keys. Use for \"Which placeholders does SignatureAPI upload upl_1AbC2dEf contain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"upload_id":{"description":"Upload id, for example upl_1AbC2dEf.","maxLength":200,"title":"Upload Id","type":"string"}},"required":["upload_id"],"title":"get_upload_structureArguments","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}}}}