Documentation sections
Product Guide
How to use the TalkPilot Dashboard — agents, tools, employees, and more
Use Cases
Step-by-step setup guides for common scenarios
API Resources
Detailed docs for each API resource with schemas and examples
Guides
Developer guides for pagination, errors, rate limiting, webhooks
Code Examples
Ready-to-use code in cURL, JavaScript, and Python
API Reference
Full OpenAPI specification with all endpoints
Quick links
- Getting Started — Create your first API key and make your first request
- Authentication — How API key authentication works
- Dashboard Overview — Learn the TalkPilot Dashboard
API overview
| Resource | Capabilities |
|---|---|
| Agents | List, read, and update AI agent configurations |
| Tools | Create, update, and delete agent tools (HTTP requests, call transfers, etc.) |
| Employees | Manage employee records and availability status |
| Forwarding Slots | Configure call routing rules with priority-based forwarding |
| Knowledge Base | Add, update, and remove knowledge base documents |
| Calls | Read call records, transcripts, and audio URLs |
| Organization | Read and update organization-level settings |
Base URL
{project_ref} with your Supabase project reference.
Key features
- API Key Authentication — Scoped keys with granular permissions per resource
- Rate Limiting — 60 req/min and 1,000 req/hour per key (customizable)
- Pagination — All list endpoints support page-based pagination
- Consistent Error Format — Structured error responses with request IDs for debugging
- Agent Scoping — API keys can be restricted to specific agents