API Reference
Build custom integrations, trigger agents programmatically, and access your data with our REST API.
π Authentication
All API requests require authentication using an API key. Include your key in the Authorization header:
curl -X GET https://api.inteliworks.com/v2/agents \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"
Getting Your API Key
Go to Dashboard β Settings β API Keys to generate your key. Keep it secret!
Rate Limits
| Plan | Rate Limit | Burst |
|---|---|---|
| Free Trial | 100 requests/hour | 10/second |
| Pro | 1,000 requests/hour | 50/second |
| Enterprise | Unlimited | Custom |
π€ Agents API
Returns a list of all agents in your account.
Response
{
"data": [
{
"id": "agent_abc123",
"name": "Lead Qualification Agent",
"status": "active",
"webhook_url": "https://agents.inteliworks.com/webhook/wh_xyz",
"executions_today": 47,
"success_rate": 98.2,
"created_at": "2026-01-01T00:00:00Z"
}
],
"meta": {
"total": 3,
"page": 1,
"per_page": 20
}
} Returns detailed information about a specific agent.
Path Parameters
Manually trigger an agent with custom input data.
Request Body
{
"input": {
"email": "lead@company.com",
"name": "John Doe",
"company": "Acme Corp",
"message": "Interested in your product"
},
"options": {
"async": false,
"callback_url": "https://your-app.com/webhook"
}
} Response
{
"execution_id": "exec_xyz789",
"status": "completed",
"output": {
"lead_score": 85,
"qualification": "HOT",
"recommended_action": "immediate_outreach"
},
"duration_ms": 1234
} Pause or resume an agent. Set status to "paused" or "active".
{
"status": "paused"
} π Executions API
Get execution history for an agent.
Query Parameters
Get full details of a specific execution including input, output, and logs.
{
"id": "exec_xyz789",
"agent_id": "agent_abc123",
"status": "completed",
"input": { "..." },
"output": { "..." },
"logs": [
{ "timestamp": "...", "level": "info", "message": "..." }
],
"started_at": "2026-01-15T14:30:00Z",
"completed_at": "2026-01-15T14:30:01Z",
"duration_ms": 1234
} π Webhooks
Webhooks allow external systems to trigger your agents. Each agent has a unique webhook URL.
curl -X POST https://agents.inteliworks.com/webhook/wh_abc123 \
-H "Content-Type: application/json" \
-H "X-API-Key: your_webhook_key" \
-d '{"email": "lead@company.com", "name": "John Doe"}' Webhook Signature Verification
For security, you can enable signature verification on outgoing webhooks. We sign the payload with your secret:
// Verify webhook signature in Node.js
const crypto = require('crypto');
function verifySignature(payload, signature, secret) {
const expected = crypto
.createHmac('sha256', secret)
.update(payload)
.digest('hex');
return crypto.timingSafeEqual(
Buffer.from(signature),
Buffer.from('sha256=' + expected)
);
} β οΈ Error Handling
The API uses standard HTTP status codes. Errors include a JSON body with details:
{
"error": {
"code": "invalid_request",
"message": "The email field is required",
"field": "email",
"docs_url": "https://docs.inteliworks.com/errors/invalid_request"
}
} | Status | Code | Description |
|---|---|---|
| 400 | invalid_request | Invalid or missing parameters |
| 401 | unauthorized | Invalid or missing API key |
| 403 | forbidden | Insufficient permissions |
| 404 | not_found | Resource not found |
| 429 | rate_limited | Too many requests |
| 500 | internal_error | Server error - retry later |
π¦ Official SDKs
Use our official SDKs for easier integration: