{"openapi":"3.1.0","info":{"title":"Simroam API","version":"0.1.0","description":"A general, hand-written educational guide to phone-connectivity options while traveling — local SIM, eSIM, international roaming, portable WiFi — with region-based guidance, a device compatibility checklist, a glossary, situational guidance and data-usage tips. Names no real carrier, eSIM provider, or plan/price.\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://simroam.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"hr@unifydynamics.com","url":"https://connectorbay.com/simroam/docs"},"termsOfService":"https://connectorbay.com/simroam/terms"},"servers":[{"url":"https://simroam.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/simroam/docs"},"security":[{},{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/connectivity_options_overview":{"post":{"operationId":"connectivity_options_overview","summary":"The four common ways to stay connected while traveling, at a glance: local SIM, eSIM, international","description":"The four common ways to stay connected while traveling, at a glance: local SIM, eSIM, international\n    roaming, portable WiFi. Use for \"what are my options for phone data abroad\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"connectivity_options_overviewArguments","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/option_detail":{"post":{"operationId":"option_detail","summary":"Full detail on one connectivity option: how it works, pros and cons. Use for \"should I get a local SIM","description":"Full detail on one connectivity option: how it works, pros and cons. Use for \"should I get a local SIM\n    or use eSIM\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"option":{"description":"'local_sim', 'esim', 'roaming_plan', or 'portable_wifi'.","examples":["esim"],"minLength":1,"title":"Option","type":"string"}},"required":["option"],"title":"option_detailArguments","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/compare_options":{"post":{"operationId":"compare_options","summary":"Lines up several connectivity options side by side.","description":"Lines up several connectivity options side by side.","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"options":{"description":"2-4 option keys to compare.","items":{"type":"string"},"maxItems":4,"minItems":2,"title":"Options","type":"array"}},"required":["options"],"title":"compare_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}},"/v1/tools/region_guidance":{"post":{"operationId":"region_guidance","summary":"General connectivity guidance for a travel scenario. Use for \"how does roaming work in the EU\".","description":"General connectivity guidance for a travel scenario. Use for \"how does roaming work in the EU\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"'european_union_eea', 'wide_regional_travel_multi_country', 'single_country_extended_stay', or 'short_business_or_layover_trip'.","examples":["european_union_eea"],"title":"Region","type":"string"}},"required":["region"],"title":"region_guidanceArguments","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/regions_list":{"post":{"operationId":"regions_list","summary":"The travel scenarios this reference has general guidance for.","description":"The travel scenarios this reference has general guidance for.","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"regions_listArguments","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/device_compatibility_checklist":{"post":{"operationId":"device_compatibility_checklist","summary":"What to check on your own phone before relying on a local SIM, eSIM, or portable WiFi abroad — unlocked","description":"What to check on your own phone before relying on a local SIM, eSIM, or portable WiFi abroad — unlocked\n    status, eSIM support, dual-SIM capability, and network band compatibility. Use for \"what should I check on\n    my phone before using a local SIM abroad\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"device_compatibility_checklistArguments","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/connectivity_glossary":{"post":{"operationId":"connectivity_glossary","summary":"Defines connectivity terms: eSIM, SIM-locked/unlocked, dual SIM (DSDS), roaming, fair use limit, network","description":"Defines connectivity terms: eSIM, SIM-locked/unlocked, dual SIM (DSDS), roaming, fair use limit, network\n    bands, portable WiFi.","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"term":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A specific term to look up; omit to list all.","title":"Term"}},"title":"connectivity_glossaryArguments","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/choose_connectivity_option":{"post":{"operationId":"choose_connectivity_option","summary":"General guidance on which connectivity option tends to fit a traveler profile. Use for \"what's the best","description":"General guidance on which connectivity option tends to fit a traveler profile. Use for \"what's the best\n    option for a two-week multi-country trip\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"profile":{"description":"'short_trip_keep_home_number', 'long_trip_single_country', 'multi_country_trip', 'traveling_with_a_group', or 'older_phone_no_esim_support'.","examples":["multi_country_trip"],"title":"Profile","type":"string"}},"required":["profile"],"title":"choose_connectivity_optionArguments","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/data_usage_tips":{"post":{"operationId":"data_usage_tips","summary":"Practical, non-carrier-specific tips for managing mobile data while traveling.","description":"Practical, non-carrier-specific tips for managing mobile data while traveling.","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"data_usage_tipsArguments","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}}}}