> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/mapbox.md).

# Mapbox

Geocode places, calculate routes and travel matrices, and render static maps.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Mapbox    | Access Token   |

#### Mapbox

Connect with a Mapbox access token to geocode places, calculate routes and travel matrices, and render static maps.

**Set up in Mapbox**

1. Prepare the Mapbox account or service that the workflow will access. Grant access to the required resources and operations.
2. **Access Token:** Create a least-privilege Mapbox token. Static Images requires the styles:tiles scope; geocoding and navigation need no extra token scope.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Mapbox**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                         |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Access Token  | Yes      | Create a least-privilege Mapbox token. Static Images requires the styles:tiles scope; geocoding and navigation need no extra token scope. [Provider instructions](https://console.mapbox.com/account/access-tokens/). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Mapbox** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Geocode address

Find Mapbox places and coordinates for an address or place.

**Inputs**

| Field            | Type    | Required | Description                                                 |
| ---------------- | ------- | -------- | ----------------------------------------------------------- |
| Address or place | string  | Yes      | Address or place to locate.                                 |
| Result limit     | integer | No       | Maximum matching places to return. Default: 5.              |
| Countries        | string  | No       | Optional country codes used to narrow results.              |
| Languages        | string  | No       | Preferred response language tags.                           |
| Autocomplete     | boolean | No       | Include prefix matches for incomplete text. Default: false. |

**Outputs**

| Field             | Type          | Description                                                 |
| ----------------- | ------------- | ----------------------------------------------------------- |
| Geocoding results | object\_array | Matching places with names, feature types, and coordinates. |
| Attribution       | string        | Mapbox attribution for these temporary results.             |

#### Reverse geocode coordinates

Find Mapbox addresses and places at a coordinate.

**Inputs**

| Field        | Type            | Required | Description                                                                                                                                        |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Longitude    | number          | Yes      | East-west coordinate from -180 through 180.                                                                                                        |
| Latitude     | number          | Yes      | North-south coordinate from -90 through 90.                                                                                                        |
| Feature type | select (string) | No       | Optional geographic feature type to return. Available values: Country, Region, Postcode, District, Place, Locality, Neighborhood, Street, Address. |
| Result limit | integer         | No       | Maximum results to return. Default: 1.                                                                                                             |
| Languages    | string          | No       | Preferred response language tags.                                                                                                                  |

**Outputs**

| Field                     | Type          | Description                                     |
| ------------------------- | ------------- | ----------------------------------------------- |
| Reverse geocoding results | object\_array | Address and place matches for the coordinate.   |
| Attribution               | string        | Mapbox attribution for these temporary results. |

#### Calculate directions/route

Calculate a route through ordered coordinates.

**Inputs**

| Field              | Type            | Required | Description                                                                                                                    |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Route coordinates  | textarea        | Yes      | Two to 25 coordinate pairs in visit order.                                                                                     |
| Travel profile     | select (string) | No       | Travel mode used to calculate the route. Available values: Driving, Driving with traffic, Walking, Cycling. Default: driving.  |
| Geometry format    | select (string) | No       | Encoding used for route geometry. Available values: GeoJSON, Polyline (precision 5), Polyline (precision 6). Default: geojson. |
| Include steps      | boolean         | No       | Include turn-by-turn route steps. Default: true.                                                                               |
| Alternative routes | boolean         | No       | Try to include up to two meaningfully different alternatives. Default: false.                                                  |

**Outputs**

| Field             | Type          | Description                                                |
| ----------------- | ------------- | ---------------------------------------------------------- |
| Routes            | object\_array | Recommended routes with totals, legs, steps, and geometry. |
| Snapped waypoints | object\_array | Input coordinates snapped to the routable network.         |

#### Calculate travel time matrix

Compare travel times or distances among coordinates.

**Inputs**

| Field               | Type            | Required | Description                                                                                                                          |
| ------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Matrix coordinates  | textarea        | Yes      | Coordinates to compare as sources and destinations.                                                                                  |
| Travel profile      | select (string) | No       | Travel mode used to calculate matrix cells. Available values: Driving, Driving with traffic, Walking, Cycling. Default: driving.     |
| Measurements        | select (string) | No       | Return travel times, distances, or both. Available values: Travel time, Route distance, Travel time and distance. Default: duration. |
| Source indexes      | string          | No       | Coordinate indexes used as origins. Default: all.                                                                                    |
| Destination indexes | string          | No       | Coordinate indexes used as destinations. Default: all.                                                                               |

**Outputs**

| Field        | Type          | Description                                               |
| ------------ | ------------- | --------------------------------------------------------- |
| Durations    | object\_array | Nullable source-by-destination travel times in seconds.   |
| Distances    | object\_array | Nullable source-by-destination route distances in meters. |
| Sources      | object\_array | Source coordinates snapped to the route network.          |
| Destinations | object\_array | Destination coordinates snapped to the route network.     |

#### Generate static map image

Render a bounded static map image for a location.

**Inputs**

| Field                | Type     | Required | Description                                                             |
| -------------------- | -------- | -------- | ----------------------------------------------------------------------- |
| Style owner          | string   | No       | Account that owns the Mapbox style. Default: mapbox.                    |
| Style ID             | string   | No       | Compatible Mapbox Studio style to render. Default: streets-v12.         |
| Center longitude     | number   | Yes      | Map center longitude from -180 through 180.                             |
| Center latitude      | number   | Yes      | Web Mercator center latitude.                                           |
| Zoom                 | number   | No       | Map zoom from 0 through 22. Default: 12.                                |
| Width                | integer  | No       | Image width in CSS pixels. Default: 600.                                |
| Height               | integer  | No       | Image height in CSS pixels. Default: 400.                               |
| Show advanced fields | boolean  | No       | Show style-owner, overlay, and high-resolution options. Default: false. |
| Overlay expression   | textarea | No       | Optional raw marker, path, or GeoJSON overlay expression.               |
| High resolution      | boolean  | No       | Render at twice the requested pixel density. Default: false.            |

**Outputs**

| Field         | Type    | Description                                    |
| ------------- | ------- | ---------------------------------------------- |
| Image base64  | string  | Validated PNG or JPEG bytes encoded as base64. |
| Media type    | string  | Detected image media type.                     |
| Size in bytes | integer | Downloaded image size before base64 encoding.  |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/mapbox.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
