Skip to content
Rindee API

Quickstart

This guide takes you from zero to your first authenticated API call.

1. Create an API key

Section titled “1. Create an API key”

In the Rindee dashboard, open Settings → API keys and create a key. The full key (rk_live_…) is shown once at creation — copy it somewhere safe. After that, only the key prefix is ever displayed.

See Authentication for capabilities and key management via the API.

2. Make a request

Section titled “2. Make a request”

Pass the key as a Bearer token in the Authorization header:

Terminal window
curl https://api.rindee.dev/v1/balance \
  -H "Authorization: Bearer rk_live_your_key_here"

A successful response returns your account’s call-credit balance as JSON.

3. List your calls

Section titled “3. List your calls”
Terminal window
curl "https://api.rindee.dev/v1/calls?limit=10" \
  -H "Authorization: Bearer rk_live_your_key_here"

List endpoints return a data array; larger collections paginate with a cursor — see Conventions.

4. Place an outbound call

Section titled “4. Place an outbound call”
Terminal window
curl -X POST https://api.rindee.dev/v1/call-actions \
  -H "Authorization: Bearer rk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "...": "see the API reference for the required fields" }'

The exact request body for each endpoint — required fields, types, and examples — is in the interactive API reference, where you can also try requests with your own key.

Next steps

Section titled “Next steps”