Back to Documentation Overview

Introduction to Dispatch API

The Dispatch API takes care of all of your routing, dispatch, and optimization needs, allowing you to focus on the other parts of your business. The API supports a wide range of use cases from ridehail to delivery services, is base-map agnostic, and is compatible with both human-driven and autonomous vehicles.

Terms

Let's first look at some important terms used frequently throughout this guide.

Tasks

Tasks refer to actions that are completed by the Dispatch API. In terms of ridehail, it can refer to trips from one location to another while for delivery services, it can refer to packages that need to be taken from point A to point B. You can find more information about tasks here.

Resources

A resource represents any entity that can be picked up or dropped off. In terms of ridehail, it can refer to passengers and for delivery it can refer to things like packages, boxes and food parcels. You can find more information about resources here.

Capacities

Capacities refer to the type and number of resources a vehicle can carry. For example, seats, number of boxes, weight etc. Refer to the guide on capacities for more information.

API Services

The Dispatch API can be further divided into:

Here is a flowchart of the basic steps you need to complete in order to build a delivery or ridehail service using the Dispatch API.

Next steps

To use the the Dispatch API, you will first need a rideOS API Key. You can sign up for one here and view it on your profile page.

Once you have the API Key, you can set the environment variable with export RIDEOS_API_KEY="YOUR_API_KEY" and use RIDEOS_API_KEY in all the cURL commands given in the documentation.

Here are some guides to get you started with the Dispatch API: