{"openapi":"3.1.0","info":{"title":"BoldSign (BYOK) API","version":"0.1.0","description":"BoldSign (BYOK) lets an AI assistant read your own BoldSign data through the BoldSign API with a key you supply (BoldSign API key). Read-only: 8 tools (list_documents, get_document_properties, list_templates, get_template_properties, get_api_credits, list_brands, list_teams, list_custom_fields). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-boldsign.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-boldsign/docs"},"termsOfService":"https://connectorbay.com/byok-boldsign/terms"},"servers":[{"url":"https://byok-boldsign.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-boldsign/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_documents":{"post":{"operationId":"list_documents","summary":"List documents in My Documents with title, status, created, activity and expiry times (Unix seconds) and labels; signer ","description":"List documents in My Documents with title, status, created, activity and expiry times (Unix seconds) and labels; signer and sender details are not returned. Use for \"Which BoldSign documents are waiting for others to sign\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"},"status":{"anyOf":[{"enum":["WaitingForMe","WaitingForOthers","NeedAttention","Completed","Declined","Revoked","Expired","Scheduled","Draft"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by one status: WaitingForMe, WaitingForOthers, NeedAttention, Completed, Declined, Revoked, Expired, Scheduled or Draft.","title":"Status"},"search_key":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text matched against document title, ID, sender or recipient name.","title":"Search Key"},"transmit_type":{"anyOf":[{"enum":["Sent","Received","Both"],"type":"string"},{"type":"null"}],"default":null,"description":"Sent, Received or Both.","title":"Transmit Type"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the transmit date range (date-time).","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the transmit date range (date-time).","title":"End Date"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 100; default 10).","title":"Page Size"}},"required":["region"],"title":"list_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/get_document_properties":{"post":{"operationId":"get_document_properties","summary":"Get a document's title, description, status, files, brand, dates, expiry, labels and reminder settings; signer and sende","description":"Get a document's title, description, status, files, brand, dates, expiry, labels and reminder settings; signer and sender identities are not returned. Use for \"What is the status and history of this BoldSign document\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"},"document_id":{"description":"Document ID (UUID) from list_documents.","maxLength":200,"title":"Document Id","type":"string"}},"required":["region","document_id"],"title":"get_document_propertiesArguments","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_templates":{"post":{"operationId":"list_templates","summary":"List templates in the account (own and shared) with title, status and activity times. Use for \"Which BoldSign templates ","description":"List templates in the account (own and shared) with title, status and activity times. Use for \"Which BoldSign templates do we have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"},"template_type":{"anyOf":[{"enum":["AllTemplates","MyTemplates","SharedTemplates"],"type":"string"},{"type":"null"}],"default":null,"description":"AllTemplates (default), MyTemplates or SharedTemplates.","title":"Template Type"},"search_key":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text matched against template ID, name and labels.","title":"Search Key"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 100; default 10).","title":"Page Size"}},"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_properties":{"post":{"operationId":"get_template_properties","summary":"Get a template's title, description, document message, files, brand, signing-order setting, labels and creation time; ro","description":"Get a template's title, description, document message, files, brand, signing-order setting, labels and creation time; role signer defaults are not returned. Use for \"What does this BoldSign template contain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"},"template_id":{"description":"Template ID (UUID) from list_templates.","maxLength":200,"title":"Template Id","type":"string"}},"required":["region","template_id"],"title":"get_template_propertiesArguments","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_api_credits":{"post":{"operationId":"get_api_credits","summary":"Show the remaining API document credits of the account. Use for \"How many BoldSign API credits do I have left\".","description":"Show the remaining API document credits of the account. Use for \"How many BoldSign API credits do I have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"}},"required":["region"],"title":"get_api_creditsArguments","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_brands":{"post":{"operationId":"list_brands","summary":"List brands with name, default flag, redirect URL, sender display name, time zone and signing-page options; logos are no","description":"List brands with name, default flag, redirect URL, sender display name, time zone and signing-page options; logos are not returned. Use for \"Which BoldSign brands are configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"}},"required":["region"],"title":"list_brandsArguments","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_teams":{"post":{"operationId":"list_teams","summary":"List teams in the organization with name, ID and creation and modification times (Unix seconds). Use for \"What teams exi","description":"List teams in the organization with name, ID and creation and modification times (Unix seconds). Use for \"What teams exist in our BoldSign account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 100; default 10).","title":"Page Size"}},"required":["region"],"title":"list_teamsArguments","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_custom_fields":{"post":{"operationId":"list_custom_fields","summary":"List reusable custom form fields with name, description, order, brand and whether they are shared. Use for \"Which custom","description":"List reusable custom form fields with name, description, order, brand and whether they are shared. Use for \"Which custom fields are defined in BoldSign\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Your BoldSign data region: 'api' (US), 'api-eu' (EU), 'api-ca' (Canada) or 'api-au' (Australia).","enum":["api","api-eu","api-ca","api-au"],"title":"Region","type":"string"}},"required":["region"],"title":"list_custom_fieldsArguments","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}}}}