Agents

Voice and phone agents — the reusable definition of who the AI is and what it should accomplish.

List agents

GET/agents

Returns the agents belonging to your organization, newest first.

GET /agents

curl -X GET "https://api.rabbitt.ai/api/v1/agents" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

GET /agents

const response = await fetch("https://api.rabbitt.ai/api/v1/agents", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

GET /agents

import os
import requests

response = requests.get(
    "https://api.rabbitt.ai/api/v1/agents",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Query parameters

typestringoptional

`phone` agents place and receive calls; `voice` agents run browser-based interviews.

One of:voicephone

default: "phone"

pageintegeroptional

default: 1 · min 1

limitintegeroptional

default: 25 · 1–100

Responses

200A paginated list of agents

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

429Rate limit exceeded

Response body - 200

objectstring

dataTypestring

dataobject[]

paginationobject

pageinteger

limitinteger

totalinteger

totalPagesinteger

hasMoreboolean

Create an agent

POST/agents

Creates a voice or phone agent. Counts against your organization's agent quota.

POST /agents

curl -X POST "https://api.rabbitt.ai/api/v1/agents" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Asha Menon",
    "instructions": "You are a friendly scheduling assistant. Confirm the appointment time."
  }'

POST /agents

const response = await fetch("https://api.rabbitt.ai/api/v1/agents", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Asha Menon",
    "instructions": "You are a friendly scheduling assistant. Confirm the appointment time."
  }),
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

POST /agents

import os
import requests

response = requests.post(
    "https://api.rabbitt.ai/api/v1/agents",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
    json={
        "name": "Asha Menon",
        "instructions": "You are a friendly scheduling assistant. Confirm the appointment time."
    },
)
response.raise_for_status()
data = response.json()

Body parameters

typestringoptional

One of:voicephone

default: "phone"

namestringrequired

max length 200

descriptionstringoptional

max length 2000

instructionsstringrequired

The agent's system prompt: who it is, what it must accomplish, and how it should behave.

max length 20000

modestringoptional

Voice agents only. Selects the prompt and report family.

One of:interviewworkflow

languagestringoptional

sectorstringoptional

maxDurationMinutesintegeroptional

1–120

providersobjectoptional

llmstringoptional

One of:mistralgeminigroq

sttstringoptional

ttsstringoptional

phoneobjectoptional

directionstringoptional

One of:outboundinboundboth

greetingstringoptional

max length 2000

fallbackstringoptional

max length 2000

voicemailBehaviorstringoptional

One of:hangupleave_messagemark_no_answer

maxAttemptsintegeroptional

1–5

retryDelayMinutesintegeroptional

min 1

requiredContactFieldsstring[]optional

outcomeLabelsstring[]optional

voiceobjectoptional

goalstringoptional

max length 2000

openingstringoptional

max length 2000

evaluationStylestringoptional

max length 2000

evaluationCriteriastring[]optional

difficultystringoptional

Responses

201The created agent

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

409Invalid request

429Rate limit exceeded

Response body - 201

idstring

objectstring

typestring

One of:voicephone

namestring

descriptionstring

modestring

languagestring

sectorstring

maxDurationMinutesinteger

instructionsstring

providersobject

llmstring

sttstring

ttsstring

sessionsCountinteger

createdAttimestamp

Retrieve an agent

GET/agents/{id}

GET /agents/{id}

curl -X GET "https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

GET /agents/{id}

const response = await fetch("https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

GET /agents/{id}

import os
import requests

response = requests.get(
    "https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200The agent

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

429Rate limit exceeded

Response body - 200

idstring

objectstring

typestring

One of:voicephone

namestring

descriptionstring

modestring

languagestring

sectorstring

maxDurationMinutesinteger

instructionsstring

providersobject

llmstring

sttstring

ttsstring

sessionsCountinteger

createdAttimestamp

Update an agent

PATCH/agents/{id}

Only the supplied fields are changed.

PATCH /agents/{id}

curl -X PATCH "https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Asha Menon",
    "description": "…",
    "instructions": "You are a friendly scheduling assistant. Confirm the appointment time.",
    "language": "…",
    "sector": "…",
    "maxDurationMinutes": 1,
    "providers": {},
    "phone": {},
    "voice": {}
  }'

PATCH /agents/{id}

const response = await fetch("https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Asha Menon",
    "description": "…",
    "instructions": "You are a friendly scheduling assistant. Confirm the appointment time.",
    "language": "…",
    "sector": "…",
    "maxDurationMinutes": 1,
    "providers": {},
    "phone": {},
    "voice": {}
  }),
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

PATCH /agents/{id}

import os
import requests

response = requests.patch(
    "https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
    json={
        "name": "Asha Menon",
        "description": "…",
        "instructions": "You are a friendly scheduling assistant. Confirm the appointment time.",
        "language": "…",
        "sector": "…",
        "maxDurationMinutes": 1,
        "providers": {},
        "phone": {},
        "voice": {}
    },
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Body parameters

namestringoptional

max length 200

descriptionstringoptional

max length 2000

instructionsstringoptional

max length 20000

languagestringoptional

sectorstringoptional

maxDurationMinutesintegeroptional

1–120

providersobjectoptional

phoneobjectoptional

voiceobjectoptional

Responses

200The updated agent

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

429Rate limit exceeded

Response body - 200

idstring

objectstring

typestring

One of:voicephone

namestring

descriptionstring

modestring

languagestring

sectorstring

maxDurationMinutesinteger

instructionsstring

providersobject

llmstring

sttstring

ttsstring

sessionsCountinteger

createdAttimestamp

Delete an agent

DELETE/agents/{id}

DELETE /agents/{id}

curl -X DELETE "https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

DELETE /agents/{id}

const response = await fetch("https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

DELETE /agents/{id}

import os
import requests

response = requests.delete(
    "https://api.rabbitt.ai/api/v1/agents/507f1f77bcf86cd799439011",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200Deletion confirmation

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

429Rate limit exceeded

Response body - 200

idstring

objectstring

deletedboolean