Developers
Developers
Build custom integrations with the CustomAgents REST API, Node.js SDK, and webhooks.
Quick start
npm install @customagents/sdkimport { CustomAgents } from '@customagents/sdk';
const client = new CustomAgents({
apiKey: process.env.CUSTOM_AGENTS_API_KEY,
});
// List all agents
const agents = await client.agents.list();
// Send a message through an agent
await client.messages.send({
agentId: 'agent_123',
to: 'customer@example.com',
subject: 'Re: Your inquiry',
body: 'Thanks for reaching out! Here is the information you requested...',
});Resources
API Reference
Full REST API documentation with endpoints, parameters, and examples
Node.js SDK
Official SDK for Node.js with TypeScript support
Connect an IDE (MCP)
Control your whole account from Claude, Cursor, VS Code or ChatGPT — send email, SMS and voice via the Model Context Protocol
API keys & scopes
Create scoped account keys, set spend caps, and understand the least-privilege scope model
Per-agent API & MCP
Mint a key pinned to a single agent for tightly-scoped automations
Webhooks
Real-time event notifications for messages, contacts, and agent activity
Authentication
All API requests require an API key passed in the Authorization header:
curl https://api.customagents.io/v1/agents \
-H "Authorization: Bearer YOUR_API_KEY"API keys are generated in the dashboard under Settings > API Keys.
Rate limits
| Plan | Requests/minute |
|---|---|
| Free | 60 |
| Starter | 120 |
| Professional | 300 |
| Enterprise | 1,000 |