{"openapi":"3.1.0","info":{"title":"Migadu (BYOK) API","version":"0.1.0","description":"Migadu (BYOK) lets an AI assistant read your own Migadu data through the Migadu API with a key you supply (Migadu account email address). Read-only: 11 tools (list_domains, get_domain, get_domain_dns_records, get_domain_usage, list_mailboxes, get_mailbox, list_mailbox_identities, list_mailbox_forwardings, list_aliases, get_alias, list_rewrites). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-migadu.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-migadu/docs"},"termsOfService":"https://connectorbay.com/byok-migadu/terms"},"servers":[{"url":"https://byok-migadu.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-migadu/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_domains":{"post":{"operationId":"list_domains","summary":"List the domains in your Migadu organization (those your role allows). The API describes each domain's state, sending an","description":"List the domains in your Migadu organization (those your role allows). The API describes each domain's state, sending and receiving flags and defaults. Use for \"Which domains do I have at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_domainsArguments","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_domain":{"post":{"operationId":"get_domain","summary":"Get one domain: state, activation dates, send/receive/access flags, spam aggressiveness, catch-all destinations and defa","description":"Get one domain: state, activation dates, send/receive/access flags, spam aggressiveness, catch-all destinations and default mailbox limits. Use for \"Is example.org active at Migadu and can it send mail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"}},"required":["domain"],"title":"get_domainArguments","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_domain_dns_records":{"post":{"operationId":"get_domain_dns_records","summary":"Get the DNS records Migadu expects for a domain: MX, SPF, DKIM, DMARC and the verification record. Use for \"Which DNS re","description":"Get the DNS records Migadu expects for a domain: MX, SPF, DKIM, DMARC and the verification record. Use for \"Which DNS records do I need for example.org at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"}},"required":["domain"],"title":"get_domain_dns_recordsArguments","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_domain_usage":{"post":{"operationId":"get_domain_usage","summary":"Get a domain's incoming and outgoing message counts and storage used (in GB) for the current day. Use for \"How much mail","description":"Get a domain's incoming and outgoing message counts and storage used (in GB) for the current day. Use for \"How much mail did example.org handle at Migadu today\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"}},"required":["domain"],"title":"get_domain_usageArguments","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_mailboxes":{"post":{"operationId":"list_mailboxes","summary":"List the mailboxes of a domain. The API describes each mailbox's address, name, protocol permissions and spam settings. ","description":"List the mailboxes of a domain. The API describes each mailbox's address, name, protocol permissions and spam settings. Use for \"Which mailboxes does example.org have at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"}},"required":["domain"],"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 by local part: address, name, send/receive and IMAP/POP3/ManageSieve permissions, spam action, expiry an","description":"Get one mailbox by local part: address, name, send/receive and IMAP/POP3/ManageSieve permissions, spam action, expiry and identities. Use for \"Show the demo@example.org mailbox at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"},"local_part":{"description":"Mailbox local part (the part before the @), for example 'demo'.","maxLength":64,"title":"Local Part","type":"string"}},"required":["domain","local_part"],"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/list_mailbox_identities":{"post":{"operationId":"list_mailbox_identities","summary":"List the sender identities of a mailbox. The API describes each identity's address, name and permissions. Use for \"Which","description":"List the sender identities of a mailbox. The API describes each identity's address, name and permissions. Use for \"Which sender identities does demo@example.org have at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"},"local_part":{"description":"Mailbox local part (the part before the @), for example 'demo'.","maxLength":64,"title":"Local Part","type":"string"}},"required":["domain","local_part"],"title":"list_mailbox_identitiesArguments","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_mailbox_forwardings":{"post":{"operationId":"list_mailbox_forwardings","summary":"List the external forwardings of a mailbox with confirmation, blocked and active state and expiry. Use for \"Where does d","description":"List the external forwardings of a mailbox with confirmation, blocked and active state and expiry. Use for \"Where does demo@example.org forward its mail at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"},"local_part":{"description":"Mailbox local part (the part before the @), for example 'demo'.","maxLength":64,"title":"Local Part","type":"string"}},"required":["domain","local_part"],"title":"list_mailbox_forwardingsArguments","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_aliases":{"post":{"operationId":"list_aliases","summary":"List the aliases of a domain. The API describes each alias's address and destinations. Use for \"Which aliases does examp","description":"List the aliases of a domain. The API describes each alias's address and destinations. Use for \"Which aliases does example.org have at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"}},"required":["domain"],"title":"list_aliasesArguments","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_alias":{"post":{"operationId":"get_alias","summary":"Get one alias by local part: address, internal-only flag, expiry and destinations. Use for \"Where does the 'sales' alias","description":"Get one alias by local part: address, internal-only flag, expiry and destinations. Use for \"Where does the 'sales' alias of example.org deliver at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"},"local_part":{"description":"Alias local part, for example 'sales'.","maxLength":64,"title":"Local Part","type":"string"}},"required":["domain","local_part"],"title":"get_aliasArguments","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_rewrites":{"post":{"operationId":"list_rewrites","summary":"List the rewrite rules (pattern-based aliases) of a domain. The API describes each rule's name, pattern and destinations","description":"List the rewrite rules (pattern-based aliases) of a domain. The API describes each rule's name, pattern and destinations. Use for \"Which rewrite patterns does example.org have at Migadu\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name hosted at Migadu, for example 'example.org'.","maxLength":253,"title":"Domain","type":"string"}},"required":["domain"],"title":"list_rewritesArguments","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}}}}