{"openapi":"3.1.0","info":{"title":"what3words (BYOK) API","version":"0.1.0","description":"what3words (BYOK) lets an AI assistant read your own what3words data through the what3words API with a key you supply (what3words API key). Read-only: 4 tools (autosuggest, list_languages, convert_to_coordinates, convert_to_three_words). 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.what3words.com....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-what3words.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-what3words/docs"},"termsOfService":"https://connectorbay.com/byok-what3words/terms"},"servers":[{"url":"https://byok-what3words.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-what3words/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/autosuggest":{"post":{"operationId":"autosuggest","summary":"Suggest valid what3words addresses from partial or slightly wrong input (two full words plus the first letter of the thi","description":"Suggest valid what3words addresses from partial or slightly wrong input (two full words plus the first letter of the third), optionally ranked near a point or limited to countries. Works on the free plan. Use for \"Which what3words addresses start with filled.count.so\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"input":{"description":"Partial three-word address: at least two complete words plus the first letter of the third, for example 'filled.count.so'.","maxLength":100,"title":"Input","type":"string"},"focus":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Latitude,longitude to rank suggestions by closeness, for example '51.52,-0.19'.","title":"Focus"},"clip_to_country":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated ISO 3166-1 alpha-2 country codes to limit results to, for example 'GB,FR'.","title":"Clip To Country"},"language":{"anyOf":[{"maxLength":5,"type":"string"},{"type":"null"}],"default":null,"description":"Fallback language code, for example 'en'.","title":"Language"}},"required":["input"],"title":"autosuggestArguments","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_languages":{"post":{"operationId":"list_languages","summary":"List the languages in which what3words addresses are available, with language code, English name and native name. Works ","description":"List the languages in which what3words addresses are available, with language code, English name and native name. Works on the free plan. Use for \"In which languages are what3words addresses available\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_languagesArguments","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/convert_to_coordinates":{"post":{"operationId":"convert_to_coordinates","summary":"Convert a three-word address to latitude and longitude, with the nearest place and a map link. Not available on the free","description":"Convert a three-word address to latitude and longitude, with the nearest place and a map link. Not available on the free plan of what3words: it needs a paid plan with a request quota. Use for \"What are the coordinates of filled.count.soap\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"words":{"description":"Three-word address such as 'filled.count.soap' (a leading /// is accepted).","maxLength":100,"title":"Words","type":"string"}},"required":["words"],"title":"convert_to_coordinatesArguments","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/convert_to_three_words":{"post":{"operationId":"convert_to_three_words","summary":"Convert latitude and longitude to the three-word address of that 3 m square, with the nearest place and a map link. Not ","description":"Convert latitude and longitude to the three-word address of that 3 m square, with the nearest place and a map link. Not available on the free plan of what3words: it needs a paid plan with a request quota. Use for \"What is the what3words address of 51.520847,-0.195521\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"coordinates":{"description":"Latitude,longitude as decimal degrees, for example '51.520847,-0.195521'.","maxLength":40,"title":"Coordinates","type":"string"},"language":{"anyOf":[{"maxLength":5,"type":"string"},{"type":"null"}],"default":"en","description":"Language code for the address (default en).","title":"Language"}},"required":["coordinates"],"title":"convert_to_three_wordsArguments","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}}}}