Platform
Company
Build custom integrations, trigger agents programmatically, and access your data with our REST API.
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"
Go to Dashboard β Settings β API Keys to generate your key. Keep it secret!
Returns a list of all agents in your account.
{ "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.
Manually trigger an agent with custom input data.
{ "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" } }
{ "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" }
Get execution history for an agent.
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 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"}'
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) ); }
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" } }
Use our official SDKs for easier integration:
We use cookies to enhance your browsing experience, serve personalized content, and analyze our traffic. By clicking "Accept All", you consent to our use of cookies. Read our Cookie Policy and Privacy Policy to learn more.
Manage your cookie preferences below. Essential cookies are required for the website to function and cannot be disabled.
Required for the website to function. Cannot be disabled.
Enable enhanced functionality and personalization.
Help us understand how visitors interact with our website.
Used to deliver relevant ads and track ad campaign performance.