API Overview

Base URL

https://api.rapidcall.ai/api

For local development: http://localhost:8787/api

Authentication

All API endpoints (except auth) require a Bearer token:

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.rapidcall.ai/api/agents

Get a token by logging in via /api/auth/login or use an API Key from the dashboard.

Response Format

All responses are JSON. Each endpoint uses a specific wrapper key:

// List endpoints
{ "agents": [...] }
{ "calls": [...] }
{ "phoneNumbers": [...] }
{ "folders": [...] }
{ "docs": [...] }

// Single-item endpoints
{ "agent": { ... } }
{ "call": { ... } }
{ "phoneNumber": { ... } }
{ "folder": { ... } }

Error responses:

{
  "error": "Unauthorized"
}

HTTP Status Codes

Code	Meaning
`200`	Success
`201`	Created
`400`	Bad request — invalid parameters
`401`	Unauthorized — missing or invalid token
`403`	Forbidden — insufficient permissions
`404`	Not found
`429`	Rate limited — too many requests
`500`	Server error

Rate Limits

Endpoint Group	Limit
Authentication	5 requests / minute
General API	100 requests / minute
AI generation (prompt assist)	10 requests / minute
Billing operations	1 request / minute

Rate limit headers are included in responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1705312800

Pagination

List endpoints support pagination:

GET /api/calls?limit=20&offset=0

Parameter	Default	Max	Description
`limit`	20	100	Items per page
`offset`	0	—	Skip N items

API Sections

Agents

Create, configure, and manage voice agents

Calls

Call history, recordings, and transcripts

Phone Numbers

Buy and manage phone numbers

Knowledge Base

Document management and search

Getting Started

Authentication

Workspaces

Agents

Workflows

Calls

Call Evaluations & Labels

Phone Numbers

Knowledge Base

Outbound Campaigns

Analytics

Billing

Integrations

Base URL

Authentication

Response Format

HTTP Status Codes

Rate Limits

API Sections

Agents

Calls

Phone Numbers

Knowledge Base

​Base URL

​Authentication

​Response Format

​HTTP Status Codes

​Rate Limits

​Pagination

​API Sections

Agents

Calls

Phone Numbers

Knowledge Base

Base URL

Authentication

Response Format

HTTP Status Codes

Rate Limits

Pagination

API Sections