{"openapi":"3.1.0","info":{"title":"Xweather (BYOK) API","version":"0.1.0","description":"Xweather (BYOK) lets an AI assistant read your own Xweather data through the Xweather API with a key you supply (Xweather client id). Read-only: 6 tools (get_observations, get_forecast, get_conditions, get_alerts, get_air_quality, get_sun_moon). 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...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-xweather.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-xweather/docs"},"termsOfService":"https://connectorbay.com/byok-xweather/terms"},"servers":[{"url":"https://byok-xweather.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-xweather/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_observations":{"post":{"operationId":"get_observations","summary":"Get the latest observation near a place: temperature, feels-like, humidity, pressure, wind, weather and icon from the ne","description":"Get the latest observation near a place: temperature, feels-like, humidity, pressure, wind, weather and icon from the nearest reporting station. Use for \"What is the weather in Minneapolis right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"place":{"description":"Place to query: 'city,state' such as 'minneapolis,mn', 'lat,lon' such as '44.98,-93.26', a US or Canadian postal code, or an ICAO or place id.","maxLength":100,"title":"Place","type":"string"},"fields":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"null"}],"default":"id,place.name,place.state,place.country,ob.dateTimeISO,ob.tempC,ob.tempF,ob.feelslikeC,ob.feelslikeF,ob.humidity,ob.pressureMB,ob.windDirDEG,ob.windDir,ob.windKPH,ob.windMPH,ob.windGustKPH,ob.weather,ob.icon,ob.precipMM,ob.isDay","description":"Comma-separated response properties to keep, in dot notation; the default keeps the main observed values.","title":"Fields"}},"required":["place"],"title":"get_observationsArguments","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_forecast":{"post":{"operationId":"get_forecast","summary":"Get the weather forecast for a place: daily (default), day and night, or hourly periods with temperatures, precipitation","description":"Get the weather forecast for a place: daily (default), day and night, or hourly periods with temperatures, precipitation chance, wind and weather. Use for \"What is the 7 day forecast for Minneapolis\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"place":{"description":"Place to query: 'city,state' such as 'minneapolis,mn', 'lat,lon' such as '44.98,-93.26', a US or Canadian postal code, or an ICAO or place id.","maxLength":100,"title":"Place","type":"string"},"filter":{"anyOf":[{"maxLength":12,"type":"string"},{"type":"null"}],"default":null,"description":"Period type: day (default), daynight, mdnt2mdnt, or an interval such as 1hr, 3hr, 6hr, 12hr, 24hr.","title":"Filter"},"limit":{"anyOf":[{"maximum":360,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of forecast periods to return (the daily default is 7).","title":"Limit"},"fields":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"null"}],"default":"place.name,place.state,place.country,interval,periods.dateTimeISO,periods.maxTempC,periods.minTempC,periods.maxTempF,periods.minTempF,periods.tempC,periods.tempF,periods.pop,periods.precipMM,periods.humidity,periods.windSpeedKPH,periods.windSpeedMPH,periods.windDir,periods.weather,periods.icon,periods.uvi","description":"Comma-separated response properties to keep, in dot notation; the default keeps the main forecast values.","title":"Fields"}},"required":["place"],"title":"get_forecastArguments","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_conditions":{"post":{"operationId":"get_conditions","summary":"Get recent, current and upcoming hourly conditions for a place (temperature, wind, precipitation, weather) as a series o","description":"Get recent, current and upcoming hourly conditions for a place (temperature, wind, precipitation, weather) as a series of periods. Use for \"What were the hourly conditions in Minneapolis over the last hours\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"place":{"description":"Place to query: 'city,state' such as 'minneapolis,mn', 'lat,lon' such as '44.98,-93.26', a US or Canadian postal code, or an ICAO or place id.","maxLength":100,"title":"Place","type":"string"},"plimit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of sub-elements (periods) to return.","title":"Plimit"},"fields":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"null"}],"default":"place.name,place.state,place.country,periods.dateTimeISO,periods.tempC,periods.tempF,periods.feelslikeC,periods.feelslikeF,periods.humidity,periods.windSpeedKPH,periods.windSpeedMPH,periods.precipMM,periods.pop,periods.weather,periods.icon,periods.uvi","description":"Comma-separated response properties to keep, in dot notation; the default keeps the main hourly values.","title":"Fields"}},"required":["place"],"title":"get_conditionsArguments","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_alerts":{"post":{"operationId":"get_alerts","summary":"List active weather alerts (watches, warnings, advisories) for a place with type, name, priority, text and issue and exp","description":"List active weather alerts (watches, warnings, advisories) for a place with type, name, priority, text and issue and expiry times. Use for \"Are there any weather alerts for Minneapolis\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"place":{"description":"Place to query: 'city,state' such as 'minneapolis,mn', 'lat,lon' such as '44.98,-93.26', a US or Canadian postal code, or an ICAO or place id.","maxLength":100,"title":"Place","type":"string"},"limit":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Number of primary results to return (default 1).","title":"Limit"},"fields":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"null"}],"default":"place.name,place.state,active,details.type,details.name,details.loc,details.priority,details.cat,details.body,timestamps.issuedISO,timestamps.beginsISO,timestamps.expiresISO","description":"Comma-separated response properties to keep, in dot notation; the default keeps alert type, name, text and times.","title":"Fields"}},"required":["place"],"title":"get_alertsArguments","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_air_quality":{"post":{"operationId":"get_air_quality","summary":"Get current air quality for a place: AQI value, category, dominant pollutant and pollutant concentrations. Counts as sev","description":"Get current air quality for a place: AQI value, category, dominant pollutant and pollutant concentrations. Counts as several requests against the plan. Use for \"How is the air quality in Minneapolis\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"place":{"description":"Place to query: 'city,state' such as 'minneapolis,mn', 'lat,lon' such as '44.98,-93.26', a US or Canadian postal code, or an ICAO or place id.","maxLength":100,"title":"Place","type":"string"},"plimit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Number of sub-elements (periods) to return.","title":"Plimit"},"fields":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"null"}],"default":"place.name,place.state,place.country,periods.dateTimeISO,periods.aqi,periods.category,periods.dominant,periods.pollutants.type,periods.pollutants.valueUGM3,periods.pollutants.aqi","description":"Comma-separated response properties to keep, in dot notation; the default keeps AQI, category and pollutants.","title":"Fields"}},"required":["place"],"title":"get_air_qualityArguments","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_sun_moon":{"post":{"operationId":"get_sun_moon","summary":"Get sunrise, sunset, twilight times and moon rise, set and phase for a place. Use for \"When is sunset in Minneapolis and","description":"Get sunrise, sunset, twilight times and moon rise, set and phase for a place. Use for \"When is sunset in Minneapolis and what is the moon phase\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"place":{"description":"Place to query: 'city,state' such as 'minneapolis,mn', 'lat,lon' such as '44.98,-93.26', a US or Canadian postal code, or an ICAO or place id.","maxLength":100,"title":"Place","type":"string"},"fields":{"anyOf":[{"maxLength":1500,"type":"string"},{"type":"null"}],"default":"place.name,place.state,sun.riseISO,sun.setISO,sun.transitISO,sun.twilight.civilBeginISO,sun.twilight.civilEndISO,moon.riseISO,moon.setISO,moon.phase.name,moon.phase.illum,moon.phase.age","description":"Comma-separated response properties to keep, in dot notation; the default keeps sun times and moon phase.","title":"Fields"}},"required":["place"],"title":"get_sun_moonArguments","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}}}}