{"openapi":"3.1.0","info":{"title":"Sinch (BYOK) API","version":"0.1.0","description":"Sinch (BYOK) lets an AI assistant read your own Sinch data through the Sinch API with a key you supply (Sinch access key ID). Read-only: 6 tools (list_active_numbers, get_active_number, list_available_regions, search_available_numbers, get_available_number, get_number_order). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-sinch.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-sinch/docs"},"termsOfService":"https://connectorbay.com/byok-sinch/terms"},"servers":[{"url":"https://byok-sinch.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-sinch/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_active_numbers":{"post":{"operationId":"list_active_numbers","summary":"List the phone numbers you own in a Sinch project with type, region, capabilities, monthly price, next charge date and S","description":"List the phone numbers you own in a Sinch project with type, region, capabilities, monthly price, next charge date and SMS or voice configuration. Use for \"Which phone numbers do I own in my Sinch project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sinch project id from the Sinch dashboard (Settings, Projects).","maxLength":200,"title":"Project Id","type":"string"},"region_code":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 3166-1 alpha-2 country code, for example US, GB or SE.","title":"Region Code"},"type":{"anyOf":[{"enum":["MOBILE","LOCAL","TOLL_FREE"],"type":"string"},{"type":"null"}],"default":null,"description":"Number type: MOBILE, LOCAL or TOLL_FREE.","title":"Type"},"number_pattern":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Digits to search for, for example 2020.","title":"Number Pattern"},"search_pattern":{"anyOf":[{"enum":["START","CONTAINS","END"],"type":"string"},{"type":"null"}],"default":null,"description":"How to apply the digits: START, CONTAINS or END.","title":"Search Pattern"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum number of items to return.","title":"Page Size"},"page_token":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The nextPageToken of a previous answer.","title":"Page Token"},"order_by":{"anyOf":[{"enum":["phoneNumber","displayName"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field: phoneNumber or displayName.","title":"Order By"}},"required":["project_id"],"title":"list_active_numbersArguments","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_active_number":{"post":{"operationId":"get_active_number","summary":"Get one phone number you own with its type, region, capabilities, price, next charge date and SMS or voice configuration","description":"Get one phone number you own with its type, region, capabilities, price, next charge date and SMS or voice configuration. Use for \"What is the configuration of my Sinch number +12025550134\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sinch project id from the Sinch dashboard (Settings, Projects).","maxLength":200,"title":"Project Id","type":"string"},"phone_number":{"description":"Phone number in E.164 format with leading +.","maxLength":200,"title":"Phone Number","type":"string"}},"required":["project_id","phone_number"],"title":"get_active_numberArguments","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_available_regions":{"post":{"operationId":"list_available_regions","summary":"List the countries and regions for which Sinch provides numbers, with the number types offered. Use for \"In which countr","description":"List the countries and regions for which Sinch provides numbers, with the number types offered. Use for \"In which countries can I get Sinch numbers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sinch project id from the Sinch dashboard (Settings, Projects).","maxLength":200,"title":"Project Id","type":"string"},"types":{"anyOf":[{"enum":["MOBILE","LOCAL","TOLL_FREE"],"type":"string"},{"type":"null"}],"default":null,"description":"Only regions offering this number type: MOBILE, LOCAL or TOLL_FREE.","title":"Types"}},"required":["project_id"],"title":"list_available_regionsArguments","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/search_available_numbers":{"post":{"operationId":"search_available_numbers","summary":"Search phone numbers that are free to order in a region, by number type and digit pattern, with setup and monthly price.","description":"Search phone numbers that are free to order in a region, by number type and digit pattern, with setup and monthly price. Searching does not buy anything. Use for \"Search for LOCAL phone numbers in the US containing 2020 at Sinch\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sinch project id from the Sinch dashboard (Settings, Projects).","maxLength":200,"title":"Project Id","type":"string"},"region_code":{"description":"ISO 3166-1 alpha-2 country code, for example US, GB or SE.","maxLength":200,"title":"Region Code","type":"string"},"type":{"description":"Number type: MOBILE, LOCAL or TOLL_FREE.","enum":["MOBILE","LOCAL","TOLL_FREE"],"title":"Type","type":"string"},"number_pattern":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Digits to search for, for example 2020.","title":"Number Pattern"},"search_pattern":{"anyOf":[{"enum":["START","CONTAINS","END"],"type":"string"},{"type":"null"}],"default":null,"description":"How to apply the digits: START, CONTAINS or END.","title":"Search Pattern"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Maximum number of items to return.","title":"Size"}},"required":["project_id","region_code","type"],"title":"search_available_numbersArguments","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_available_number":{"post":{"operationId":"get_available_number","summary":"Check whether one specific phone number is available and see its capabilities, setup price and whether supporting docume","description":"Check whether one specific phone number is available and see its capabilities, setup price and whether supporting documents are required. Use for \"Is +12025550134 available at Sinch\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sinch project id from the Sinch dashboard (Settings, Projects).","maxLength":200,"title":"Project Id","type":"string"},"phone_number":{"description":"Phone number to check, in E.164 format with leading +.","maxLength":200,"title":"Phone Number","type":"string"}},"required":["project_id","phone_number"],"title":"get_available_numberArguments","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_number_order":{"post":{"operationId":"get_number_order","summary":"Get a number order with its state, region, number type, reserved numbers with prices, and create, update and expiry time","description":"Get a number order with its state, region, number type, reserved numbers with prices, and create, update and expiry times. Use for \"What is the state of my Sinch number order 01HZ\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Sinch project id from the Sinch dashboard (Settings, Projects).","maxLength":200,"title":"Project Id","type":"string"},"number_order_id":{"description":"Number order id returned when the order was created.","maxLength":200,"title":"Number Order Id","type":"string"}},"required":["project_id","number_order_id"],"title":"get_number_orderArguments","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}}}}