{"openapi":"3.1.0","info":{"title":"Ship Engine Carrier Catalog (your key) API","version":"0.1.0","description":"Ship Engine Carrier Catalog (your key) lets an AI assistant read your own Ship Engine Carriers data through the Ship Engine Carriers API with a key you supply (ShipEngine API key). Read-only: 5 tools (list_carriers, get_carrier, list_carrier_services, list_carrier_package_types, list_carrier_options). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-shipengine-carriers.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-shipengine-carriers/docs"},"termsOfService":"https://connectorbay.com/byok-shipengine-carriers/terms"},"servers":[{"url":"https://byok-shipengine-carriers.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-shipengine-carriers/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_carriers":{"post":{"operationId":"list_carriers","summary":"List the carrier accounts connected to the account: carrier id, code, nickname, friendly name, primary flag and the serv","description":"List the carrier accounts connected to the account: carrier id, code, nickname, friendly name, primary flag and the services each offers (balances and account numbers are left out). Use for \"Which carriers are connected to my ShipEngine account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_carriersArguments","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_carrier":{"post":{"operationId":"get_carrier","summary":"Get one connected carrier account by id: code, nickname, friendly name, primary flag and services. Use for \"Show carrier","description":"Get one connected carrier account by id: code, nickname, friendly name, primary flag and services. Use for \"Show carrier se-123890\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_id":{"description":"ShipEngine carrier account id such as 'se-123890' (from list_carriers).","maxLength":60,"title":"Carrier Id","type":"string"}},"required":["carrier_id"],"title":"get_carrierArguments","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_carrier_services":{"post":{"operationId":"list_carrier_services","summary":"List the shipping services (for example USPS Priority Mail) of one carrier account, with domestic and international flag","description":"List the shipping services (for example USPS Priority Mail) of one carrier account, with domestic and international flags. Use for \"What shipping services does carrier se-123890 offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_id":{"description":"ShipEngine carrier account id such as 'se-123890' (from list_carriers).","maxLength":60,"title":"Carrier Id","type":"string"}},"required":["carrier_id"],"title":"list_carrier_servicesArguments","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_carrier_package_types":{"post":{"operationId":"list_carrier_package_types","summary":"List the package types (envelope, box, flat rate and similar) a carrier account supports, with code, name and descriptio","description":"List the package types (envelope, box, flat rate and similar) a carrier account supports, with code, name and description. Use for \"Which package types can I use with carrier se-123890\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_id":{"description":"ShipEngine carrier account id such as 'se-123890' (from list_carriers).","maxLength":60,"title":"Carrier Id","type":"string"}},"required":["carrier_id"],"title":"list_carrier_package_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}},"/v1/tools/list_carrier_options":{"post":{"operationId":"list_carrier_options","summary":"List the advanced shipment options (for example saturday delivery) a carrier account supports, with default values. Use ","description":"List the advanced shipment options (for example saturday delivery) a carrier account supports, with default values. Use for \"Which advanced options does carrier se-123890 support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"carrier_id":{"description":"ShipEngine carrier account id such as 'se-123890' (from list_carriers).","maxLength":60,"title":"Carrier Id","type":"string"}},"required":["carrier_id"],"title":"list_carrier_optionsArguments","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}}}}