{"openapi":"3.1.0","info":{"title":"Parseur (BYOK) API","version":"0.1.0","description":"Parseur (BYOK) lets an AI assistant read your own Parseur data through the Parseur API with a key you supply (Parseur API key). Read-only: 7 tools (list_mailboxes, get_mailbox, get_mailbox_schema, list_templates, get_template, list_custom_downloads, get_preset_types). 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...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-parseur.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-parseur/docs"},"termsOfService":"https://connectorbay.com/byok-parseur/terms"},"servers":[{"url":"https://byok-parseur.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-parseur/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_mailboxes":{"post":{"operationId":"list_mailboxes","summary":"List mailboxes (parsers) with AI engine, document counts per processing status, template and webhook counts, retention a","description":"List mailboxes (parsers) with AI engine, document counts per processing status, template and webhook counts, retention and last activity. Use for \"Which Parseur mailboxes have failed documents\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Case-insensitive partial match on the mailbox name.","title":"Search"},"ordering":{"anyOf":[{"enum":["name","-name","document_count","-document_count","template_count","-template_count","PARSEDOK_count","-PARSEDOK_count","PARSEDKO_count","-PARSEDKO_count","QUOTAEXC_count","-QUOTAEXC_count","EXPORTKO_count","-EXPORTKO_count","TRANSKO_count","-TRANSKO_count"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by name, document_count, template_count, PARSEDOK_count, PARSEDKO_count, QUOTAEXC_count, EXPORTKO_count or TRANSKO_count; prefix with - for descending.","title":"Ordering"},"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":25,"description":"Results per page (default 25).","title":"Page Size"}},"title":"list_mailboxesArguments","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_mailbox":{"post":{"operationId":"get_mailbox","summary":"Get one mailbox's settings: AI engine and instructions, allowed file extensions, preset type, retention, counts per stat","description":"Get one mailbox's settings: AI engine and instructions, allowed file extensions, preset type, retention, counts per status (email address and download links are not returned). Use for \"How is the Parseur mailbox 12345 configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mailbox_id":{"description":"Mailbox id (a number), as returned by list_mailboxes.","title":"Mailbox Id","type":"integer"}},"required":["mailbox_id"],"title":"get_mailboxArguments","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_mailbox_schema":{"post":{"operationId":"get_mailbox_schema","summary":"Get the field schema of a mailbox: the properties each parsed document will contain. Use for \"Which fields does Parseur ","description":"Get the field schema of a mailbox: the properties each parsed document will contain. Use for \"Which fields does Parseur extract in mailbox 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mailbox_id":{"description":"Mailbox id (a number), as returned by list_mailboxes.","title":"Mailbox Id","type":"integer"}},"required":["mailbox_id"],"title":"get_mailbox_schemaArguments","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 the parsing templates of a mailbox with engine (text or OCR), action, draft or production status and document count","description":"List the parsing templates of a mailbox with engine (text or OCR), action, draft or production status and document count. Use for \"Which Parseur templates does mailbox 12345 have and are they in production\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mailbox_id":{"description":"Mailbox id (a number), as returned by list_mailboxes.","title":"Mailbox Id","type":"integer"},"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":25,"description":"Results per page (default 25).","title":"Page Size"}},"required":["mailbox_id"],"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 parsing template's engine, action, status, margins, document count and date and decimal formats (field boxes and","description":"Get one parsing template's engine, action, status, margins, document count and date and decimal formats (field boxes and download links are not returned). Use for \"Show Parseur template 777\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"template_id":{"description":"Template id (a number), as returned by list_templates.","title":"Template Id","type":"integer"}},"required":["template_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_custom_downloads":{"post":{"operationId":"list_custom_downloads","summary":"List a mailbox's custom download definitions with name, type and the items they include (download links are not returned","description":"List a mailbox's custom download definitions with name, type and the items they include (download links are not returned). Use for \"Which custom downloads are defined for Parseur mailbox 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"mailbox_id":{"description":"Mailbox id (a number), as returned by list_mailboxes.","maxLength":200,"title":"Mailbox Id","type":"string"}},"required":["mailbox_id"],"title":"list_custom_downloadsArguments","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_preset_types":{"post":{"operationId":"get_preset_types","summary":"Get the preset mailbox types Parseur offers (slug, name, description) and field length limits. Use for \"Which ready-made","description":"Get the preset mailbox types Parseur offers (slug, name, description) and field length limits. Use for \"Which ready-made Parseur mailbox types exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_preset_typesArguments","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}}}}