Quickstart

You need an organization API key, the API origin for your environment, and the ID of one of your organization’s caregivers for the chat and voice examples. An Org Admin creates keys in Settings → API Keys in the dashboard.

Set your environment

Run requests from your server or a trusted terminal. Production examples use https://backend.drivehealth.ai; replace it with the origin supplied for your environment when testing elsewhere.

export DRIVEHEALTH_API_BASE="https://backend.drivehealth.ai"
export DRIVEHEALTH_API_KEY="dh_REPLACE_WITH_YOUR_KEY"
export DRIVEHEALTH_CAREGIVER_ID="REPLACE_WITH_YOUR_CAREGIVER_UUID"

DRIVEHEALTH_API_BASE is the origin only. Request paths include /api.

Confirm the key

Confirm that the key is active and can read its organization:

curl --fail-with-body \
  --header "Authorization: Bearer $DRIVEHEALTH_API_KEY" \
  "$DRIVEHEALTH_API_BASE/api/calls?limit=1"

A successful request returns 200 OK with a page of calls. An empty results array only means the organization has no matching calls; it does not mean authentication failed:

{
  "count": 0,
  "next": null,
  "previous": null,
  "results": []
}

A refused request returns 403 Forbidden with a detail message. Check that the key is active, that the origin matches your environment, and that you send only one credential. See Authentication.

Next steps

Chat

Create a chat session and exchange messages.

Voice calls

Start a phone call or register a web call.

Results

Read calls, chats, and recordings.

Get started

Use the API

Set your environment

Confirm the key

Next steps

Chat

Voice calls

Results

​Set your environment

​Confirm the key

​Next steps

Chat

Voice calls

Results

Set your environment

Confirm the key

Next steps