{"openapi":"3.1.0","info":{"title":"Signaturit (BYOK) API","version":"0.1.0","description":"Signaturit (BYOK) lets an AI assistant read your own Signaturit data through the Signaturit API with a key you supply (Signaturit production access token). Read-only: 9 tools (count_signatures, list_signatures, get_signature, count_certified_emails, list_templates, list_brandings, get_credits, list_event_subscriptions, list_team_groups). The BYOK key travels with each request, is used for that...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-signaturit.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-signaturit/docs"},"termsOfService":"https://connectorbay.com/byok-signaturit/terms"},"servers":[{"url":"https://byok-signaturit.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-signaturit/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/count_signatures":{"post":{"operationId":"count_signatures","summary":"Count signature requests, optionally by status and send date range. Use for \"How many Signaturit signature requests were","description":"Count signature requests, optionally by status and send date range. Use for \"How many Signaturit signature requests were completed this year\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["in_queue","ready","signing","completed","expired","canceled","declined","error"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by status: in_queue, ready, signing, completed, expired, canceled, declined or error.","title":"Status"},"since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items sent on or after this date (YYYY-MM-DD).","title":"Since"},"until":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items sent before this date (YYYY-MM-DD).","title":"Until"}},"title":"count_signaturesArguments","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_signatures":{"post":{"operationId":"list_signatures","summary":"List signature requests with creation time and their documents (signer name and email, status, events, file name and siz","description":"List signature requests with creation time and their documents (signer name and email, status, events, file name and size). Up to 100 per call; filter by status and send dates. Use for \"Which Signaturit signature requests are still waiting to be signed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["in_queue","ready","signing","completed","expired","canceled","declined","error"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by status: in_queue, ready, signing, completed, expired, canceled, declined or error.","title":"Status"},"since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items sent on or after this date (YYYY-MM-DD).","title":"Since"},"until":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items sent before this date (YYYY-MM-DD).","title":"Until"},"ids":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated signature IDs to restrict to.","title":"Ids"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Results to skip, for paging.","title":"Offset"}},"title":"list_signaturesArguments","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_signature":{"post":{"operationId":"get_signature","summary":"Get one signature request with its documents, signers' status and events. Use for \"What is the status of this Signaturit","description":"Get one signature request with its documents, signers' status and events. Use for \"What is the status of this Signaturit signature request\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"signature_id":{"description":"Signature request ID (UUID) from list_signatures.","maxLength":200,"title":"Signature Id","type":"string"}},"required":["signature_id"],"title":"get_signatureArguments","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/count_certified_emails":{"post":{"operationId":"count_certified_emails","summary":"Count certified emails, optionally by status (in_queue, sent, error) and send date. Use for \"How many certified emails d","description":"Count certified emails, optionally by status (in_queue, sent, error) and send date. Use for \"How many certified emails did we send via Signaturit\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["in_queue","sent","error"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by in_queue, sent or error.","title":"Status"},"since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items sent on or after this date (YYYY-MM-DD).","title":"Since"}},"title":"count_certified_emailsArguments","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 signature templates with ID, name and creation date (up to 100 per call). Use for \"Which Signaturit templates do I ","description":"List signature templates with ID, name and creation date (up to 100 per call). Use for \"Which Signaturit templates do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Results to skip, for paging.","title":"Offset"}},"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/list_brandings":{"post":{"operationId":"list_brandings","summary":"List custom brandings with colors, application texts and creation date (up to 10 per call). Use for \"Which Signaturit br","description":"List custom brandings with colors, application texts and creation date (up to 10 per call). Use for \"Which Signaturit brandings are set up\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":10,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 10).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Results to skip, for paging.","title":"Offset"},"since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only brandings created on or after this date (YYYY-MM-DD).","title":"Since"},"until":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only brandings created before this date (YYYY-MM-DD).","title":"Until"}},"title":"list_brandingsArguments","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_credits":{"post":{"operationId":"get_credits","summary":"Show remaining credits per product type (certified file, certified SMS, photo ID, batch and others) with period and usag","description":"Show remaining credits per product type (certified file, certified SMS, photo ID, batch and others) with period and usage. Use for \"How many Signaturit credits do I have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_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_event_subscriptions":{"post":{"operationId":"list_event_subscriptions","summary":"List webhook subscriptions with target URL, subscribed events and creation date. Use for \"Which Signaturit webhook subsc","description":"List webhook subscriptions with target URL, subscribed events and creation date. Use for \"Which Signaturit webhook subscriptions are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Results to skip, for paging.","title":"Offset"},"event":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only subscriptions attached to this event type.","title":"Event"}},"title":"list_event_subscriptionsArguments","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_team_groups":{"post":{"operationId":"list_team_groups","summary":"List team groups with ID, name and creation date. Use for \"What groups exist in our Signaturit team\".","description":"List team groups with ID, name and creation date. Use for \"What groups exist in our Signaturit team\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_team_groupsArguments","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}}}}