canonical: https://jentic.com/apis/roadie.com/roadie

# Roadie API

Roadie delivery API for generating price estimates, creating and managing shipments, tracking deliveries, and managing driver ratings and tips. The API exposes 12 endpoints secured with bearer authentication.

## For AI agents

Programmatically generate a delivery price quote, create and schedule a new delivery. Covers 12 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for analytics only.

## Capabilities

- Generate a delivery price quote
- Create and schedule a new delivery
- Retrieve multiple shipments by filter
- Update shipment before driver assignment
- Cancel a shipment before pickup is confirmed
- Add gratuity after driver acceptance

## Use cases

### Analytics Operations

Use the Roadie API to perform analytics operations programmatically. The API provides 12 endpoints covering core functionality including generate a delivery price quote, create and schedule a new delivery, retrieve multiple shipments by filter.

Example prompt: Call POST /estimates to generate a delivery price quote

### Automated Estimates Management

Automate estimates operations by combining multiple Roadie API endpoints. Agents can create and schedule a new delivery and then retrieve multiple shipments by filter in a single workflow.

Example prompt: Call POST /shipments to create and schedule a new delivery, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Roadie API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'generate a delivery price quote', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/estimates` | Generate a delivery price quote |
| POST | `/shipments` | Create and schedule a new delivery |
| GET | `/shipments` | Retrieve multiple shipments by filter |
| GET | `/shipments/{id}` | Retrieve shipment details by Roadie ID |
| PATCH | `/shipments/{id}` | Update shipment before driver assignment |
| DELETE | `/shipments/{id}` | Cancel a shipment before pickup is confirmed |
| PUT | `/shipments/{id}/tips` | Add gratuity after driver acceptance |
| POST | `/shipments/{id}/ratings` | Rate driver performance (1-5 scale) |

## Key resources

- **Estimates** — Operations for estimates
- **Shipments** — Operations for shipments

## Why Jentic

- **Setup:** Wiring the Roadie API by hand means managing its bearer token, sending it on every call to the connect.roadie.com host, and handling estimate, shipment, tip, and rating requests yourself. Through Jentic you install once, import the Roadie API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Roadie puts the shipment id in the URL path (`/shipments/{id}`), so a rule can pin your agent to one shipment: it can read and update that shipment and nothing else. You choose the operations it may call, so destructive ones like deleting a shipment are not included unless you add them.
- **Credential handling:** Your Roadie token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'generate a delivery price quote' or 'create a shipment', and Jentic returns the matching Roadie API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the Roadie API use?

The Roadie API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I generate a delivery price quote with the Roadie API?

Yes. Use the POST /estimates endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Roadie API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I generate a delivery price quote through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'generate a delivery price quote'. Jentic returns the matching Roadie API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Roadie API have?

The Roadie API exposes 12 endpoints covering estimates, shipments operations.

### Can I limit what my agent is allowed to do with the Roadie API?

Yes. Jentic One runs self-hosted, so your own rules decide which Roadie API operations and credentials the agent may use. Because Roadie puts the shipment id in the URL path (`/shipments/{id}`), you can pin the agent to a single shipment so it only reads and updates that one and nothing else. You also choose which operations it may call, so destructive actions like DELETE `/shipments/{id}` stay off unless you explicitly add them.