Developer Resources

API Documentation

Integrate CloudEvolve's Digital Worker capabilities into your applications

Authentication

Get your API keys and authenticate requests

Getting Started

Quick start guide to make your first API call

Webhooks

Real-time event notifications for your app

Overview

The CloudEvolve API enables you to programmatically access your Digital Worker's capabilities. Build custom integrations, automate workflows, and extend CloudEvolve's functionality to meet your specific needs.

Base URL

https://api.cloudevolve.ai/v1

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

curl https://api.cloudevolve.ai/v1/calls \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Security: Keep your API keys secure. Never expose them in client-side code or public repositories.

API Endpoints

Calls

GET/calls

Retrieve a list of all calls handled by your Digital Worker

{
  "calls": [
    {
      "id": "call_123abc",
      "phone": "+1234567890",
      "direction": "inbound",
      "duration": 142,
      "timestamp": "2024-12-05T10:30:00Z",
      "status": "completed",
      "transcript": "Full call transcript...",
      "sentiment": "positive"
    }
  ],
  "total": 1,
  "page": 1
}

POST/calls

Initiate an outbound call

{
  "phone": "+1234567890",
  "campaign_id": "campaign_xyz",
  "custom_data": {
    "customer_name": "John Doe",
    "account_id": "12345"
  }
}

Leads

GET/leads

Retrieve qualified leads with scoring and tags

POST/leads

Create a new lead in the system

Appointments

GET/appointments

List all scheduled appointments

PUT/appointments/:id

Update an existing appointment

Webhooks

Receive real-time notifications when events occur in your CloudEvolve account:

•call.completed - Triggered when a call ends
•lead.qualified - Triggered when a lead is scored and tagged
•appointment.scheduled - Triggered when a new appointment is booked
•appointment.cancelled - Triggered when an appointment is cancelled

{
  "event": "call.completed",
  "timestamp": "2024-12-05T10:30:00Z",
  "data": {
    "call_id": "call_123abc",
    "duration": 142,
    "sentiment": "positive",
    "transcript": "Full transcript...",
    "lead_score": 85
  }
}

Rate Limits

API rate limits vary by plan tier:

Starter

1,000

requests/hour

Professional

10,000

requests/hour

Enterprise

Custom

Need Help?

Our developer support team is here to help you integrate CloudEvolve into your applications.