{"openapi":"3.1.0","info":{"title":"ImprovMX (BYOK) API","version":"0.1.0","description":"ImprovMX (BYOK) lets an AI assistant read your own ImprovMX data through the ImprovMX API with a key you supply (API key). Read-only: 9 tools (get_account, list_domains, get_domain, list_aliases, get_alias, list_rules, list_smtp_credentials, list_email_logs, list_whitelabel_domains). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-improvmx.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-improvmx/docs"},"termsOfService":"https://connectorbay.com/byok-improvmx/terms"},"servers":[{"url":"https://byok-improvmx.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-improvmx/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/get_account":{"post":{"operationId":"get_account","summary":"Show the ImprovMX account: owner email, country, plan name and price, domain and alias limits, and lock state. Use for \"","description":"Show the ImprovMX account: owner email, country, plan name and price, domain and alias limits, and lock state. Use for \"What ImprovMX plan am I on and what are my domain and alias limits\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","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_domains":{"post":{"operationId":"list_domains","summary":"List the domains on ImprovMX with forwarding and sending readiness, routing engine, notification email and dates. Use fo","description":"List the domains on ImprovMX with forwarding and sending readiness, routing engine, notification email and dates. Use for \"Which of my ImprovMX domains are not yet forwarding\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only domains containing this text.","title":"Query"},"forwarding_ready":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for domains whose MX records point to ImprovMX, false for the others.","title":"Forwarding Ready"},"send_ready":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for domains ready to send mail, false for the others.","title":"Send Ready"},"order":{"anyOf":[{"enum":["name_asc","name_desc","created_asc","created_desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order.","title":"Order"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (default 20, up to 200).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"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's forwarding and sending readiness, routing engine, notification email, strict MX flag and dates. Use for","description":"Get one domain's forwarding and sending readiness, routing engine, notification email, strict MX flag and dates. Use for \"Is example.com ready to forward mail on ImprovMX\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name added to ImprovMX, for example 'example.com'.","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/list_aliases":{"post":{"operationId":"list_aliases","summary":"List the email aliases of a domain with the destination each forwards to. Use for \"Where does info@example.com forward o","description":"List the email aliases of a domain with the destination each forwards to. Use for \"Where does info@example.com forward on ImprovMX\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name added to ImprovMX, for example 'example.com'.","maxLength":253,"title":"Domain","type":"string"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only aliases or destinations containing this text.","title":"Query"},"order":{"anyOf":[{"enum":["name_asc","name_desc","created_asc","created_desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order.","title":"Order"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (default 20, up to 200).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"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 of a domain by its name (for example 'info') or numeric id. Use for \"What does the 'info' alias of example","description":"Get one alias of a domain by its name (for example 'info') or numeric id. Use for \"What does the 'info' alias of example.com forward to on ImprovMX\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name added to ImprovMX, for example 'example.com'.","maxLength":253,"title":"Domain","type":"string"},"alias_id":{"description":"Alias name such as 'info', or the numeric id from list_aliases.","maxLength":100,"title":"Alias Id","type":"string"}},"required":["domain","alias_id"],"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_rules":{"post":{"operationId":"list_rules","summary":"List the routing rules of a domain (alias, regex or expression rules) with type, rank, active flag and configuration. Us","description":"List the routing rules of a domain (alias, regex or expression rules) with type, rank, active flag and configuration. Use for \"What routing rules does example.com have on ImprovMX\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name added to ImprovMX, for example 'example.com'.","maxLength":253,"title":"Domain","type":"string"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only rules containing this text.","title":"Query"},"order":{"anyOf":[{"enum":["rank_asc","rank_desc","created_asc","created_desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order.","title":"Order"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (default 20, up to 200).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["domain"],"title":"list_rulesArguments","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_smtp_credentials":{"post":{"operationId":"list_smtp_credentials","summary":"List the SMTP sending credentials (usernames, creation date and usage count only; passwords are never returned) of a dom","description":"List the SMTP sending credentials (usernames, creation date and usage count only; passwords are never returned) of a domain. Use for \"Which SMTP sending users exist for example.com on ImprovMX\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name added to ImprovMX, for example 'example.com'.","maxLength":253,"title":"Domain","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (default 20, up to 200).","title":"Limit"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["domain"],"title":"list_smtp_credentialsArguments","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_email_logs":{"post":{"operationId":"list_email_logs","summary":"List recent delivery logs of a domain: sender, recipient, subject, transport and delivery events (queued, delivered, bou","description":"List recent delivery logs of a domain: sender, recipient, subject, transport and delivery events (queued, delivered, bounced, refused). Use for \"Did the last emails to info@example.com get delivered on ImprovMX\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name added to ImprovMX, for example 'example.com'.","maxLength":253,"title":"Domain","type":"string"},"sender":{"anyOf":[{"maxLength":254,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs from exactly this sender address.","title":"Sender"},"recipient":{"anyOf":[{"maxLength":254,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs to exactly this recipient address.","title":"Recipient"},"status":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs with an event of this status: QUEUED, DELIVERED, SOFT-BOUNCE, HARD-BOUNCE, BOUNCED or REFUSED (comma-separate several).","title":"Status"},"transport":{"anyOf":[{"enum":["mx","smtp","api"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this transport.","title":"Transport"},"after":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs after this ISO 8601 time.","title":"After"},"before":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only logs before this ISO 8601 time.","title":"Before"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Entries per page (default 100, up to 200).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Pass next_cursor from the previous answer to get the next page.","title":"Cursor"}},"required":["domain"],"title":"list_email_logsArguments","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_whitelabel_domains":{"post":{"operationId":"list_whitelabel_domains","summary":"List the whitelabel (parent) domains configured on the account. Use for \"Which whitelabel domains do I have on ImprovMX\"","description":"List the whitelabel (parent) domains configured on the account. Use for \"Which whitelabel domains do I have on ImprovMX\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_whitelabel_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}}}}