{"openapi":"3.1.0","info":{"title":"OS Downloads (BYOK) API","version":"0.1.0","description":"OS Downloads (BYOK) lets an AI assistant read your own OS Downloads data through the OS Downloads API with a key you supply (OS Data Hub project API key). Read-only: 7 tools (list_opendata_products, get_opendata_product, list_opendata_downloads, list_data_packages, get_data_package, list_data_package_versions, get_data_package_version). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-osdownloads.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-osdownloads/docs"},"termsOfService":"https://connectorbay.com/byok-osdownloads/terms"},"servers":[{"url":"https://byok-osdownloads.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-osdownloads/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_opendata_products":{"post":{"operationId":"list_opendata_products","summary":"List the OS OpenData products available for download; set expanded to true to get full details for each product. Use for","description":"List the OS OpenData products available for download; set expanded to true to get full details for each product. Use for \"Which Ordnance Survey OpenData products can be downloaded\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"expanded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to return the full details of every product instead of the short listing.","title":"Expanded"}},"title":"list_opendata_productsArguments","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_opendata_product":{"post":{"operationId":"get_opendata_product","summary":"Get one OS OpenData product: description, version, covered grid areas, data structures, file formats, documentation link","description":"Get one OS OpenData product: description, version, covered grid areas, data structures, file formats, documentation link and end-of-life notice. Use for \"Show the details of the OS Open Greenspace product\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_id":{"description":"OS OpenData product id, for example 'OpenGreenspace' (from list_opendata_products).","maxLength":80,"title":"Product Id","type":"string"}},"required":["product_id"],"title":"get_opendata_productArguments","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_opendata_downloads":{"post":{"operationId":"list_opendata_downloads","summary":"List the downloadable files of an OS OpenData product (file name, size, MD5, format, grid area), optionally filtered by ","description":"List the downloadable files of an OS OpenData product (file name, size, MD5, format, grid area), optionally filtered by format, sub-format, area or file name. Use for \"Which GeoPackage files does OS Open Greenspace offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_id":{"description":"OS OpenData product id, for example 'OpenGreenspace' (from list_opendata_products).","maxLength":80,"title":"Product Id","type":"string"},"format":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only files of this format, for example 'GeoPackage' or 'ESRI Shapefile'.","title":"Format"},"subformat":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only files of this sub-format.","title":"Subformat"},"area":{"anyOf":[{"enum":["GB","HP","HT","HU","HW","HX","HY","HZ","NA","NB","NC","ND","NF","NG","NH","NJ","NK","NL","NM","NN","NO","NR","NS","NT","NU","NW","NX","NY","NZ","OV","SD","SE","TA","SH","SJ","SK","TF","TG","SM","SN","SO","SP","TL","TM","SR","SS","ST","SU","TQ","TR","SV","SW","SX","SY","SZ","TV"],"type":"string"},{"type":"null"}],"default":null,"description":"Only files covering this grid area (GB for the whole country, or a two-letter grid square).","title":"Area"},"file_name":{"anyOf":[{"maxLength":120,"type":"string"},{"type":"null"}],"default":null,"description":"Only the file with exactly this name.","title":"File Name"}},"required":["product_id"],"title":"list_opendata_downloadsArguments","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_data_packages":{"post":{"operationId":"list_data_packages","summary":"List the OS Select+Build data packages available to your project, with product and version summaries (needs a plan that ","description":"List the OS Select+Build data packages available to your project, with product and version summaries (needs a plan that includes data packages). Use for \"Which OS data packages are available to my project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_data_packagesArguments","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_data_package":{"post":{"operationId":"get_data_package","summary":"Get one data package: name, product and the list of its versions. Use for \"Show OS data package 1234\".","description":"Get one data package: name, product and the list of its versions. Use for \"Show OS data package 1234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"data_package_id":{"description":"Data package id (from list_data_packages).","maxLength":40,"title":"Data Package Id","type":"string"}},"required":["data_package_id"],"title":"get_data_packageArguments","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_data_package_versions":{"post":{"operationId":"list_data_package_versions","summary":"List the versions of a data package (creation date, reason, full or change-only supply, product version, format). Use fo","description":"List the versions of a data package (creation date, reason, full or change-only supply, product version, format). Use for \"List the versions of OS data package 1234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"data_package_id":{"description":"Data package id (from list_data_packages).","maxLength":40,"title":"Data Package Id","type":"string"}},"required":["data_package_id"],"title":"list_data_package_versionsArguments","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_data_package_version":{"post":{"operationId":"get_data_package_version","summary":"Get one data package version, including the files available to download (name, size, MD5); use 'latest' for the newest v","description":"Get one data package version, including the files available to download (name, size, MD5); use 'latest' for the newest version. Use for \"What files are in the latest version of OS data package 1234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"data_package_id":{"description":"Data package id (from list_data_packages).","maxLength":40,"title":"Data Package Id","type":"string"},"version_id":{"description":"Version id, or the word 'latest'.","maxLength":40,"title":"Version Id","type":"string"}},"required":["data_package_id","version_id"],"title":"get_data_package_versionArguments","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}}}}