{"openapi":"3.1.0","info":{"title":"SMSAPI (BYOK) API","version":"0.1.0","description":"SMSAPI (BYOK) lets an AI assistant read your own SMSAPI data through the SMSAPI API with a key you supply (SMSAPI OAuth token). Read-only: 6 tools (get_account_profile, list_sender_names, list_contacts, list_blacklist, list_subusers, list_prices). 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.smsapi.com....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-smsapi.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-smsapi/docs"},"termsOfService":"https://connectorbay.com/byok-smsapi/terms"},"servers":[{"url":"https://byok-smsapi.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-smsapi/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_profile":{"post":{"operationId":"get_account_profile","summary":"Show the SMSAPI account name, email, username, payment type (prepaid or postpaid), user type and the number of credits (","description":"Show the SMSAPI account name, email, username, payment type (prepaid or postpaid), user type and the number of credits (points) left. Use for \"How many SMSAPI credits do I have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_account_profileArguments","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_sender_names":{"post":{"operationId":"list_sender_names","summary":"List the sender names (alphanumeric senders) registered on the account with status, default flag and creation date. Use ","description":"List the sender names (alphanumeric senders) registered on the account with status, default flag and creation date. Use for \"Which sender names are active on my SMSAPI account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_sender_namesArguments","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_contacts":{"post":{"operationId":"list_contacts","summary":"List contacts in the SMSAPI contact database with name, phone number, email, city, country, source, dates and group memb","description":"List contacts in the SMSAPI contact database with name, phone number, email, city, country, source, dates and group membership. Filter by text, phone, email, name or group; page with offset and limit. Use for \"Find the SMSAPI contact with email bok@example.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"q":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search over name, surname, phone number, email and city.","title":"Q"},"phone_number":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only the contact with this phone number, digits with country code, for example 48500500500.","title":"Phone Number"},"email":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the contact with this email address.","title":"Email"},"first_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only contacts with this first name.","title":"First Name"},"last_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only contacts with this last name.","title":"Last Name"},"group_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only contacts in the group with this id.","title":"Group Id"},"sort":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to sort by; prefix with - for descending, for example -last_name.","title":"Sort"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many contacts to return (this connector allows 1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many contacts to skip, for paging.","title":"Offset"}},"title":"list_contactsArguments","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_blacklist":{"post":{"operationId":"list_blacklist","summary":"List phone numbers on the account's blacklist (numbers that will not be messaged) with the date added and expiry. Use fo","description":"List phone numbers on the account's blacklist (numbers that will not be messaged) with the date added and expiry. Use for \"Which numbers are blacklisted in SMSAPI\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_blacklistArguments","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_subusers":{"post":{"operationId":"list_subusers","summary":"List the sub-user accounts with username, active flag, description and their credit limits. Use for \"Which SMSAPI sub-us","description":"List the sub-user accounts with username, active flag, description and their credit limits. Use for \"Which SMSAPI sub-users exist and how many credits does each have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_subusersArguments","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_prices":{"post":{"operationId":"list_prices","summary":"List the current SMSAPI price list by service type, country and network, in the account currency. Use for \"What does SMS","description":"List the current SMSAPI price list by service type, country and network, in the account currency. Use for \"What does SMSAPI charge per SMS to Poland\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maxLength":6,"type":"string"},{"type":"null"}],"default":"ALL","description":"Use ALL (the documented value) to get the full price list.","title":"Limit"}},"title":"list_pricesArguments","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}}}}