{"openapi":"3.1.0","info":{"title":"Simbase (BYOK) API","version":"0.1.0","description":"Simbase (BYOK) lets an AI assistant read your own Simbase data through the Simbase API with a key you supply (Simbase API key). Read-only: 5 tools (get_balance, list_sim_cards, get_sim_card, get_sim_usage, list_plans). 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 api.simbase.com. Unofficial connector by Unify...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-simbase.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-simbase/docs"},"termsOfService":"https://connectorbay.com/byok-simbase/terms"},"servers":[{"url":"https://byok-simbase.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-simbase/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_balance":{"post":{"operationId":"get_balance","summary":"Show the Simbase account balance with currency, last update time and auto top-up settings. Use for \"What is my Simbase b","description":"Show the Simbase account balance with currency, last update time and auto top-up settings. Use for \"What is my Simbase balance\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_balanceArguments","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_sim_cards":{"post":{"operationId":"list_sim_cards","summary":"List the SIM cards of the account with ICCID, device name, state, coverage, tags, IP and this month's data, SMS and voic","description":"List the SIM cards of the account with ICCID, device name, state, coverage, tags, IP and this month's data, SMS and voice usage. Filter by state, coverage, tag or search text. Use for \"Which of my Simbase SIM cards are enabled and how much data did they use this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sim_state":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only SIM cards in this network state, for example enabled or disabled.","title":"Sim State"},"coverage":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only SIM cards with this coverage, for example Europe or Global.","title":"Coverage"},"tags":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only SIM cards with this tag.","title":"Tags"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text to find in device name, ICCID and other fields.","title":"Search"},"pagesize":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"SIM cards per page, 1 to 250.","title":"Pagesize"},"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_sim_cardsArguments","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_sim_card":{"post":{"operationId":"get_sim_card","summary":"Get one SIM card: state, carrier, country, plan, APN, radio technology, throttle, tags and this month's usage. Device lo","description":"Get one SIM card: state, carrier, country, plan, APN, radio technology, throttle, tags and this month's usage. Device location and IMEI are not returned. Use for \"Show details of Simbase SIM 8912300000000000001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"iccid":{"description":"ICCID of the SIM card (19 digits), from list_sim_cards.","maxLength":200,"title":"Iccid","type":"string"}},"required":["iccid"],"title":"get_sim_cardArguments","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_sim_usage":{"post":{"operationId":"get_sim_usage","summary":"Get one SIM card's usage and cost for a calendar month: data, SMS and voice usage, charges per category, sessions and lo","description":"Get one SIM card's usage and cost for a calendar month: data, SMS and voice usage, charges per category, sessions and location updates. Use for \"How much did Simbase SIM 8912300000000000001 cost in 2026-09\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"iccid":{"description":"ICCID of the SIM card (19 digits), from list_sim_cards.","maxLength":200,"title":"Iccid","type":"string"},"month":{"description":"Calendar month as YYYY-MM.","maxLength":200,"title":"Month","type":"string"}},"required":["iccid","month"],"title":"get_sim_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_plans":{"post":{"operationId":"list_plans","summary":"List the rate plans available for your SIM cards with plan id, coverage name, currency, daily, per-MB and SMS rates and ","description":"List the rate plans available for your SIM cards with plan id, coverage name, currency, daily, per-MB and SMS rates and country count. Use for \"What Simbase rate plans can I assign and what do they cost per MB\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_plansArguments","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}}}}