{"openapi":"3.1.0","info":{"title":"EasyPost (BYOK) API","version":"0.1.0","description":"EasyPost (BYOK) lets an AI assistant read your own EasyPost data through the EasyPost API with a key you supply (API key (test or production)). Read-only: 7 tools (list_shipments, list_trackers, get_tracker, list_batches, get_batch, list_insurances, list_reports). 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 to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-easypost.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-easypost/docs"},"termsOfService":"https://connectorbay.com/byok-easypost/terms"},"servers":[{"url":"https://byok-easypost.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-easypost/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_shipments":{"post":{"operationId":"list_shipments","summary":"List your shipments, newest first, with status, tracking code, addresses and dates. Covers the last month unless a date ","description":"List your shipments, newest first, with status, tracking code, addresses and dates. Covers the last month unless a date window is given; only purchased shipments by default. Use for \"What are my latest EasyPost shipments\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Page Size"},"before_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created before this id (use the id of the last record of the previous page). Do not combine with after_id.","title":"Before Id"},"after_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created after this id. Do not combine with before_id.","title":"After Id"},"start_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only shipments created after this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: one month ago).","title":"Start Datetime"},"end_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only shipments created before this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: end of today).","title":"End Datetime"},"purchased":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True (default) to list only purchased shipments, false to include unpurchased ones.","title":"Purchased"},"include_children":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include shipments of child users.","title":"Include Children"}},"title":"list_shipmentsArguments","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_trackers":{"post":{"operationId":"list_trackers","summary":"List package trackers, newest first, with carrier, status, estimated delivery date, the latest scan events and a public ","description":"List package trackers, newest first, with carrier, status, estimated delivery date, the latest scan events and a public tracking URL. Last month unless a date window is given. Use for \"Where are my EasyPost packages right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Page Size"},"before_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created before this id (use the id of the last record of the previous page). Do not combine with after_id.","title":"Before Id"},"after_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created after this id. Do not combine with before_id.","title":"After Id"},"start_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only trackers created after this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: one month ago).","title":"Start Datetime"},"end_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only trackers created before this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: end of today).","title":"End Datetime"},"carrier":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only trackers of this carrier, for example 'USPS'.","title":"Carrier"}},"title":"list_trackersArguments","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_tracker":{"post":{"operationId":"get_tracker","summary":"Get one tracker by id with its status, estimated delivery date and the full list of tracking events. Use for \"What is th","description":"Get one tracker by id with its status, estimated delivery date and the full list of tracking events. Use for \"What is the tracking history of EasyPost tracker trk_123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"tracker_id":{"description":"Tracker id starting with trk_, from list_trackers.","maxLength":60,"title":"Tracker Id","type":"string"}},"required":["tracker_id"],"title":"get_trackerArguments","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_batches":{"post":{"operationId":"list_batches","summary":"List shipment batches with their state, shipment counts and dates, newest first by default. Last month unless a date win","description":"List shipment batches with their state, shipment counts and dates, newest first by default. Last month unless a date window is given. Use for \"What shipment batches have I created in EasyPost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many records to return (1 to 100, default 10).","title":"Page Size"},"before_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created before this id (use the id of the last record of the previous page). Do not combine with after_id.","title":"Before Id"},"after_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created after this id. Do not combine with before_id.","title":"After Id"},"start_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only batches created after this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: one month ago).","title":"Start Datetime"},"end_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only batches created before this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: end of today).","title":"End Datetime"},"sort":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Order by creation time: asc or desc.","title":"Sort"}},"title":"list_batchesArguments","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_batch":{"post":{"operationId":"get_batch","summary":"Get one batch by id or reference with its state, per-status shipment counts, shipments, pickup and scan form. Use for \"S","description":"Get one batch by id or reference with its state, per-status shipment counts, shipments, pickup and scan form. Use for \"Show me the details of EasyPost batch batch_123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"batch_id":{"description":"Batch id starting with batch_ (or its reference).","maxLength":80,"title":"Batch Id","type":"string"}},"required":["batch_id"],"title":"get_batchArguments","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_insurances":{"post":{"operationId":"list_insurances","summary":"List insurance records for shipments with status, amount, provider and tracking code. Last month unless a date window is","description":"List insurance records for shipments with status, amount, provider and tracking code. Last month unless a date window is given. Use for \"What shipment insurance do I have in EasyPost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records to return (1 to 100, default 20).","title":"Page Size"},"before_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created before this id (use the id of the last record of the previous page). Do not combine with after_id.","title":"Before Id"},"after_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only records created after this id. Do not combine with before_id.","title":"After Id"},"start_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only insurance records created after this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: one month ago).","title":"Start Datetime"},"end_datetime":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only insurance records created before this ISO 8601 time, for example 2026-01-01T00:00:00Z (default: end of today).","title":"End Datetime"}},"title":"list_insurancesArguments","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_reports":{"post":{"operationId":"list_reports","summary":"List generated reports of one type (for example shipment or tracker) with status, date range and a time-limited download","description":"List generated reports of one type (for example shipment or tracker) with status, date range and a time-limited download URL. Use for \"What shipment reports has EasyPost generated for me\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"report_type":{"description":"Report type: cash_flow, insurance, payment_log, refund, shipment, shipment_invoice or tracker.","enum":["cash_flow","insurance","payment_log","refund","shipment","shipment_invoice","tracker"],"title":"Report Type","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many reports to return (1 to 100, default 20).","title":"Page Size"},"before_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only reports created before this id.","title":"Before Id"},"after_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Return only reports created after this id.","title":"After Id"}},"required":["report_type"],"title":"list_reportsArguments","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}}}}