> For the complete documentation index, see [llms.txt](https://docs.os.uk/os-downloads/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.os.uk/os-downloads/resources/product-resources/psga-product-summary-table.md).

# PSGA Product Summary Table

## OS National Geographic Database

The OS National Geographic Database (OS NGD) is the latest generation of authoritative geospatial data to describe the geography of Great Britain – delivering increased currency, improved data structures and enhanced metadata to allow users to make the most of OS data.

| Product                                                                                                                          | Description                                                                                                                                |
| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| <h4><a href="https://docs.os.uk/osngd/">OS National Geographic Database (OS NGD)</a></h4>                                        | Authoritative data describing the geography of Great Britain by bringing together multiple data collections and themes as a single source. |
| <h4><a href="https://docs.os.uk/osngd/accessing-os-ngd/access-the-os-ngd-api/os-ngd-api-features">OS NGD API – Features</a></h4> | An API providing access to filtered OS NGD features data.                                                                                  |
| <h4><a href="https://docs.os.uk/osngd/accessing-os-ngd/access-the-os-ngd-api/os-ngd-api-tiles">OS NGD API – Tiles</a></h4>       | An API providing access to vector tile services powered by the OS NGD.                                                                     |

## APIs

Ordnance Survey APIs give programmatic access to OS data and services, providing a powerful gateway to rich geospatial data that empowers organisations to integrate mapping data into their applications.

| Product                                                                                                                 | Description                                                                                                                                     |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-apis/accessing-os-apis/os-maps-api">OS Maps API</a></h4>                             | Access detailed pre-rendered raster tiles in multiple styles to make intelligent location-based decisions within your applications.             |
| <h4><a href="https://docs.os.uk/os-apis/accessing-os-apis/os-features-api">OS Features API</a></h4>                     | Access to OS data filtered by feature layers to apply only the data you need as and when you need it.                                           |
| <h4><a href="https://docs.os.uk/os-apis/accessing-os-apis/os-vector-tile-api">OS Vector Tile API</a></h4>               | Access detailed OS MasterMap data as a vector tile service, providing a customisable basemap optimised for use with most web mapping libraries. |
| <h4><a href="https://docs.os.uk/os-apis/accessing-os-apis/os-linked-identifiers-api">OS Linked Identifiers API</a></h4> | Access data defining valuable links and relationships between properties, streets and OS MasterMap identifiers.                                 |
| <h4><a href="https://docs.os.uk/os-apis/accessing-os-apis/os-places-api">OS Places API</a></h4>                         | Direct access to rich sets of addressing data, providing a detailed view of an address and its lifecycle.                                       |
| <h4><a href="https://docs.os.uk/os-apis/accessing-os-apis/os-names-api">OS Names API</a></h4>                           | A geographic directory that supports the discovery, identification and visualisation of identifiable places within OS data.                     |
| <h4><a href="https://docs.os.uk/os-apis/accessing-os-apis/os-downloads-api">OS Downloads API</a></h4>                   | Provides automated access to OS data products and packages for integration with existing systems and software.                                  |

## Download data products

OS produces two types of **Download data product**: Premium and OpenData:

* Premium products refer to paid-for datasets – whether they’re paid for by businesses, purchased through an [OS Partner](https://www.ordnancesurvey.co.uk/customers/os-channel-partners), or accessed free at the point of use under the [PSGA](https://www.ordnancesurvey.co.uk/customers/public-sector/public-sector-geospatial-agreement).
* OpenData products are free to use by anyone for any purpose – including for services from which you make a profit.

Download data products are grouped by portfolio: [Addresses and names](#addresses-and-names), [Areas and zones](#areas-and-zones), [Buildings and infrastructure](#buildings-and-infrastructure), [Land and terrain](#land-and-terrain), [Maps and imagery](#maps-and-imagery), [Transport network](#transport-network), and [Water](#water).

### Addresses and names

Explore mapping data relating to addresses, Unique Property Reference Numbers (UPRNs), named features and places. Discover address details, postcodes, identifiers and features.

| Product                                                                                                                                                                | Description                                                                                                                                                                                                                                                                 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/addressbase">AddressBase</a></h4>                                                  | <p>Access to a current view of all Royal Mail Postcode Address File (PAF) addresses with additional location-based data featuring residential or commercial classifications.</p><p>N.B. This product will become End of Life on 29 November 2027 and will be withdrawn.</p> |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/addressbase-core">AddressBase Core</a></h4>                                        | Access to over 33 million addresses sourced from Local Authority data and supplied with a Unique Property Reference Number (UPRN) and property-level coordinates.                                                                                                           |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/addressbase-plus">AddressBase Plus</a></h4>                                        | <p>Access to over 37 million postal and non-postal addresses sourced from Local Authorities, Ordnance Survey, and Royal Mail for England, Wales, and Scotland.</p><p>N.B. This product will become End of Life on 29 November 2027 and will be withdrawn.</p>               |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/addressbase-plus-islands"><strong>AddressBase Plus Islands</strong></a></h4>       | <p>An addressing gazetteer offering full lifecycle information of a property for Northern Ireland, Isle of Man and the Channel Islands.</p><p>N.B. This product will become End of Life on 29 November 2027 and will be withdrawn.</p>                                      |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/addressbase-premium">AddressBase Premium</a></h4>                                  | Provides the most detailed view available of an address and its lifecycle from creation through to retirement in England, Wales and Scotland.                                                                                                                               |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/addressbase-premium-islands"><strong>AddressBase Premium Is</strong>lands</a></h4> | Provides the most detailed view of an address and its lifecycle for Northern Ireland, Channel Islands and the Isle of Man.                                                                                                                                                  |
| <h4><a href="https://docs.os.uk/os-downloads/products/areas-and-zones-portfolio/code-point">Code-Point</a></h4>                                                        | A postcode locator that locates over 1.7 million postcode units in Great Britain and Northern Ireland – providing information about delivery points, positional quality, type and district codes amongst other data points.                                                 |
| <h4><a href="https://docs.os.uk/os-downloads/products/areas-and-zones-portfolio/code-point-open">Code-Point Open</a></h4>                                              | An open dataset of all 1.7 million postcode units in Great Britain.                                                                                                                                                                                                         |
| <h4><a href="https://docs.os.uk/os-downloads/products/areas-and-zones-portfolio/code-point-with-polygons">Code-Point with Polygons</a></h4>                            | A dataset providing the notional extent of every postcode in Great Britain for visualisation and analysis at a national scale.                                                                                                                                              |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/os-emergency-services-gazetteer">OS Emergency Services Gazetteer (OS ESG)</a></h4> | Provides a national, consistent, and maintained view of the locations of names, places and objects in Great Britain to support the Emergency Services.                                                                                                                      |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/os-open-names">OS Open Names</a></h4>                                              | A comprehensive open dataset of place names, road numbers and postcodes for Great Britain.                                                                                                                                                                                  |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/os-open-uprn/">OS Open UPRN</a></h4>                                               | An open dataset enabling linking, sharing and visualisation of data related to Unique Property Reference Numbers (UPRNs).                                                                                                                                                   |

### **Areas and zones**

Explore mapping data designed to provide information about areas used for administration and analysis. Discover postcodes, boundaries and built up areas.

|                                                                                                                                                |                                                                                                                                                                                                                             |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-downloads/areas-and-zones/boundary-line">Boundary-Line</a></h4>                                             | An open dataset that represents every administrative and electoral boundary and their names for England, Scotland, and Wales.                                                                                               |
| <h4><a href="https://docs.os.uk/os-downloads/products/areas-and-zones-portfolio/code-point">Code-Point</a></h4>                                | A postcode locator that locates over 1.7 million postcode units in Great Britain and Northern Ireland – providing information about delivery points, positional quality, type and district codes amongst other data points. |
| <h4><a href="https://docs.os.uk/os-downloads/products/areas-and-zones-portfolio/code-point-open">Code-Point Open</a></h4>                      | An open dataset of all 1.7 million postcode units in Great Britain.                                                                                                                                                         |
| <h4><a href="https://docs.os.uk/os-downloads/products/areas-and-zones-portfolio/code-point-with-polygons">Code-Point with Polygons</a></h4>    | A dataset providing the notional extent of every postcode in Great Britain for visualisation and analysis at a national scale.                                                                                              |
| <h4><a href="https://docs.os.uk/os-downloads/products/areas-and-zones/os-open-built-up-areas"><strong>OS Open Built Up Areas</strong></a></h4> | Provides a dataset representing Built Up Areas of Great Britain designed to underpin statistical analysis and contribute to policy enablement across the public sector.                                                     |

### Buildings and infrastructure

Explore mapping data designed to provide information about the built environment. Discover building and structure features, identifiers and topography layers.

|                                                                                                                                                                                                                          |                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-mastermap-topography-layer">OS MasterMap Topography Layer</a></h4>                                                                   | A detailed and accurate view of the landscape of Great Britain, representing both the manmade and natural environment with over 500 million real-world objects.                                         |
| <h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-mastermap-topography-layer-building-height-attribute">OS MasterMap Topography Layer – Building Height Attribute</a></h4> | An enhancement to OS MasterMap Topography Layer that provides building height properties to manage assets, plan works, and visualise urban density.                                                     |
| <h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-open-linked-identifiers">OS Open Linked Identifiers</a></h4>                                                             | An open dataset of cross-referenced identifiers detailing relationships between Unique Property Reference Numbers (UPRNs), Unique Street Reference Numbers (USRNs) and Topographic Identifiers (TOIDs). |
| <h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-open-toid">OS Open TOID</a></h4>                                                                                         | An open dataset of unique identifiers for landscape and built environment features with a generalised location extracted from OS MasterMap products.                                                    |

### **Land and terrain**

Explore mapping data designed to show land cover, land use and elevation. Discover land and built environment features, greenspace and topography layers.

| Product                                                                                                                                                      | Description                                                                                                                                                                                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-downloads/products/land-and-terrain-portfolio/os-mastermap-greenspace-layer">OS MasterMap Greenspace Layer</a></h4>       | <p>A detailed dataset of public and private greenspaces within urban areas for Great Britain.<br>N.B. This product will become End of Life on 31 March 2027 and will be withdrawn.</p>                  |
| <h4><a href="https://docs.os.uk/os-downloads/products/land-and-terrain-portfolio/os-mastermap-sites-layer">OS MasterMap Sites Layer</a></h4>                 | A dataset containing the detailed extents of important locations such as airports, schools, hospitals, utility and infrastructure sites, and more.                                                      |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-mastermap-topography-layer">OS MasterMap Topography Layer</a></h4>       | A detailed and accurate view of the landscape of Great Britain, representing both the manmade and natural environment with over 500 million real-world objects.                                         |
| <h4><a href="https://docs.os.uk/os-downloads/products/land-and-terrain-portfolio/os-open-greenspace">OS Open Greenspace</a></h4>                             | An open dataset depicting the location, access and extent of spaces such as parks and sports facilities likely to be accessible to the public.                                                          |
| <h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-open-linked-identifiers">OS Open Linked Identifiers</a></h4> | An open dataset of cross-referenced identifiers detailing relationships between Unique Property Reference Numbers (UPRNs), Unique Street Reference Numbers (USRNs) and Topographic Identifiers (TOIDs). |
| <h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-open-toid">OS Open TOID</a></h4>                             | An open dataset of unique identifiers for landscape and built environment features with a generalised location extracted from OS MasterMap products.                                                    |
| <h4><a href="https://docs.os.uk/os-downloads/products/land-and-terrain-portfolio/os-terrain-50">OS Terrain 50</a></h4>                                       | An open height dataset of contours with spot heights, breaklines, coastline, lakes, ridges and formlines for Great Britain provided at 10metre intervals.                                               |

### **Maps and imagery**

Explore mapping data designed to provide visual context, allowing you to perform simple analysis. Discover raster and vector maps, imagery and topography layers.

| Product                                                                                                                                                | Description                                                                                                                                                     |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/1-25-000-scale-colour-raster">1:25 000 Scale Colour Raster</a></h4>   | A digital alternative to the OS Explorer paper map series for Great Britain, available in 10km square tiles.                                                    |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/1-50-000-scale-colour-raster">1:50 000 Scale Colour Raster</a></h4>   | A digital alternative to the OS Explorer paper map series for Great Britain, available in 20km square tiles.                                                    |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/1-250-000-scale-colour-raster">1:250 000 Scale Colour Raster</a></h4> | An open small-scale digital raster mapping product giving a regional view of Great Britain. Similar in content and appearance to a typical road atlas.          |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/gb-overview-maps">GB Overview Maps</a></h4>                           | Two overview maps of Great Britain at 1:5 000 000 scale for commercial, personal, or educational use. An OpenData product.                                      |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/miniscale">MiniScale</a></h4>                                         | A small-scale digital map of Great Britain designed for customers requiring high-quality mapping for documents and publications. An OpenData product.           |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-mastermap-topography-layer">OS MasterMap Topography Layer</a></h4> | A detailed and accurate view of the landscape of Great Britain, representing both the manmade and natural environment with over 500 million real-world objects. |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-open-zoomstack">OS Open Zoomstack</a></h4>                         | An open vector basemap showing a range of coverage of Great Britain from a national level down to street level detail.                                          |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-openmap-local">OS OpenMap – Local</a></h4>                         | A dataset of detailed, street-level mapping of Great Britain, providing one of the most detailed generalised open mapping products available.                   |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-vectormap-district">OS VectorMap District</a></h4>                 | An open simple vector dataset, designed for creating graphical mapping with a nominal scale of 1:25 000 covering the whole of Great Britain.                    |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-vectormap-local">OS VectorMap Local</a></h4>                       | A highly detailed and customisable street-level map showing fences, building outlines, paths and street names.                                                  |

### **Transport network**

Explore mapping data designed to provide information about roads, paths, trams, ferries and railways. Discover transport networks, features and identifiers.

<table><thead><tr><th width="396.4000244140625">Product</th><th>Description</th></tr></thead><tbody><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-detailed-path-network">OS Detailed Path Network</a></h4></td><td><p>A fully connected, heighted path network covering Britain’s National Parks to allow users to create off-road navigation websites and apps.</p><p>N.B. This product will become End of Life on 30 September 2026 and will be withdrawn.</p></td></tr><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-mastermap-highways-network-paths">OS MasterMap Highways Network – Paths</a></h4></td><td>A path network dataset for Great Britain showing who is responsible for all the footpaths through towns and cities in Great Britain.</td></tr><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-mastermap-highways-network-roads">OS MasterMap Highways Network – Roads</a></h4></td><td>A navigable road network dataset with detailed information about planned roads and roads under construction.</td></tr><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-mastermap-highways-network-rami">OS MasterMap Highways Network – Routing and Asset Management Information (RAMI)</a></h4></td><td>Routing data from Ordnance Survey's large-scale road and path data integrated with data from the National Street Gazetteer (NSG), the Trunk Road Street Gazetteer (TRSG) and the Scottish Street Gazetteer (SSG).</td></tr><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-multi-modal-routing-network">OS Multi-modal Routing Network (OS MRN)</a></h4></td><td>A fully connected routable network containing  multi-modal connectivity between road, rail,  path and ferry networks for the routing of people and goods.</td></tr><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-open-roads">OS Open Roads</a></h4></td><td>An open dataset providing a high-level digital representation of Great Britain's road network.</td></tr><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/transport-network-portfolio/os-open-usrn">OS Open USRN</a></h4></td><td>An open dataset containing all Unique Street Reference Numbers (USRNs) from OS MasterMap Highways Network.</td></tr><tr><td><h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-open-linked-identifiers"><strong>OS Open Linked Identifiers</strong></a></h4></td><td>An open dataset of cross-referenced identifiers detailing relationships between Unique Property Reference Numbers (UPRNs), Unique Street Reference Numbers (USRNs) and Topographic Identifiers (TOIDs).</td></tr></tbody></table>

### Water

Explore mapping data designed to show water bodies, tidelines and river networks. Discover water features, identifiers and topography layers.

|                                                                                                                                                              |                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-mastermap-topography-layer">OS MasterMap Topography Layer</a></h4>       | A detailed and accurate view of the landscape of Great Britain, representing both the manmade and natural environment with over 500 million real-world objects.                                         |
| <h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-open-linked-identifiers">OS Open Linked Identifiers</a></h4> | An open dataset of cross-referenced identifiers detailing relationships between Unique Property Reference Numbers (UPRNs), Unique Street Reference Numbers (USRNs) and Topographic Identifiers (TOIDs). |
| <h4><a href="https://docs.os.uk/os-downloads/products/water-portfolio/os-open-rivers">OS Open Rivers</a></h4>                                                | An open dataset providing a high-level view of over 144 000km of water bodies and watercourses in Great Britain.                                                                                        |
| <h4><a href="https://docs.os.uk/os-downloads/products/buildings-and-infrastructure-portfolio/os-open-toid">OS Open TOID</a></h4>                             | An open dataset of unique identifiers for landscape and built environment features with a generalised location extracted from OS MasterMap products.                                                    |

## Additional products outside of the PSGA

The following premium, prototype and beta products are not available as part of the PSGA; these can often be trialled through using product sample data or accessed through an OS licensed partner by following the links under 'How to get this product' / 'Try this product' from the relevant product pages below:

| Product                                                                                                                                          | Description                                                                                                                                                                                                                                                                                                                                     |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4><a href="https://docs.os.uk/os-downloads/beta-products/beta-products-information/os-3d-mesh-beta-product">OS 3D Mesh (beta product)</a></h4> | A stand-alone beta product providing a three-dimensional representation of the surface of the Earth and any features sitting above it.                                                                                                                                                                                                          |
| <h4><a href="/pages/BWOBnBOPqyEvShNiwdRe">OS BaseMap Pro (prototype 2 product)</a></h4>                                                          | OS BaseMap Pro will be our newest topographic vector product, providing our most detailed, trusted and accurate representation of Great Britain’s built and natural landscape. It will deliver a clear and consistent basemap for organisations that need to visualise, locate and digitise large-scale features with high-quality cartography. |
| <h4><a href="/pages/CX2ytZtTuGRMI08y9TNH">OS Enhanced Land Cover (beta product)</a></h4>                                                         | A stand-alone beta product providing a comprehensive view of the natural habitat within England by aggregating authoritative OS data with a wide range of third-party land cover and ecological datasets. It lets you effectively assess and monitor the land cover of a site.                                                                  |
| <h4><a href="https://docs.os.uk/os-downloads/products/maps-and-imagery-portfolio/os-mastermap-imagery-layer">OS MasterMap Imagery Layer</a></h4> | Provides digital aerial photography of Great Britain that has been colour-balanced and corrected for geometric distortions.                                                                                                                                                                                                                     |
| <h4><a href="https://docs.os.uk/os-downloads/products/land-and-terrain-portfolio/os-terrain-5">OS Terrain 5</a></h4>                             | Provides a highly detailed digital terrain model (DTM) of Great Britain as a grid of heighted points or contours at 5metre intervals.                                                                                                                                                                                                           |
| <h4><a href="https://docs.os.uk/os-downloads/products/addresses-and-names-portfolio/points-of-interest">Points of Interest</a></h4>              | Provides a comprehensive location-based directory of all public and privately owned businesses, educational institutions and leisure services in Great Britain.                                                                                                                                                                                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.os.uk/os-downloads/resources/product-resources/psga-product-summary-table.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
