> ## Documentation Index
> Fetch the complete documentation index at: https://help.bodharouteplanner.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Introduction

> Everything you need to integrate with Bodha Route Planner programmatically.

# Bodha Route Planner REST API

The Bodha Route Planner API lets you push orders from your OMS, read optimized routes, update
stop status from your own systems, and receive real-time webhook notifications
when things happen.

> [!NOTE]
>
> The API is available on the **Pro** plan. You can manage your API keys from
> **Settings → Developer Portal** in the Bodha Route Planner dashboard.

## Base URL

```
https://api.bodha.run/api/v1
```

All endpoints are prefixed with `/api/v1`. Responses are JSON.

## Quick start

**1. Create an API key**

Go to **Settings → Developer Portal** and click **Create key**. Choose your
scopes and copy the key — it's shown only once.

**2. Make your first request**

```bash theme={null}
curl -H "X-API-Key: bk_live_abc123..." \
     https://api.bodha.run/api/v1/ping
```

**3. Push an order**

```bash theme={null}
curl -X POST https://api.bodha.run/api/v1/orders \
     -H "X-API-Key: bk_live_abc123..." \
     -H "Content-Type: application/json" \
     -d '{
       "externalOrderId": "ORD-1043",
       "recipient": { "fullName": "Jane Smith" },
       "location": {
         "address": "456 Oak Ave, San Francisco, CA 94102",
         "latitude": 37.7751,
         "longitude": -122.4193
       }
     }'
```

**4. Set up a webhook**

In the Developer Portal, add a webhook endpoint to get notified when routes
are dispatched or stops are completed.

## Resources

| Resource | Description |
| - | - |
| [Routes](https://help.bodharouteplanner.com/api-reference/routes/list-routes.md) | Planned and active delivery routes |
| [Stops](https://help.bodharouteplanner.com/api-reference/stops/get-stop.md) | Individual delivery or pickup stops on a route |
| [Orders](https://help.bodharouteplanner.com/api-reference/orders/list-orders.md) | Incoming work from your OMS or integrations |
| [Webhooks](https://help.bodharouteplanner.com/api-reference/webhooks/overview.md) | Real-time event notifications |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.