API Documentation

Build powerful integrations with our comprehensive REST API. Access all platform features programmatically.

Quick Start

1. Get Your API Key

Sign up for a Creatyvot account and generate your API key from the dashboard.

Get API Key

2. Make Your First Request

Use your API key to authenticate requests and start building integrations.

curl -H "Authorization: Bearer YOUR_API_KEY" \
    https://api.creatyvot.com/v1/status

3. Explore Endpoints

Browse our comprehensive API reference to discover all available endpoints and features.

View Endpoints

Authentication

All API requests require authentication using your API key. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Security Note: Keep your API key secure and never expose it in client-side code. For production applications, consider using environment variables or secure key management systems.

API Endpoints

GET/api/v1/messages

Retrieve messages from conversations

Parameters:

limitoffsetconversation_idstatus
POST/api/v1/messages

Send a new message

Parameters:

tomessagetypeconversation_id
GET/api/v1/conversations

Get all conversations

Parameters:

limitoffsetstatusagent_id
POST/api/v1/conversations

Create a new conversation

Parameters:

contact_idagent_idsubject
GET/api/v1/contacts

Retrieve contacts

Parameters:

limitoffsetsearchtags
POST/api/v1/contacts

Create or update a contact

Parameters:

phonenameemailtags
GET/api/v1/webhooks

Get webhook configurations

Parameters:

typestatus
POST/api/v1/webhooks

Create a new webhook

Parameters:

urleventssecret

Code Examples

Send Message

JavaScript

const response = await fetch('https://api.creatyvot.com/v1/messages', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    to: '+1234567890',
    message: 'Hello from Creatyvot!',
    type: 'text',
    conversation_id: 'conv_123'
  })
});

const result = await response.json();

Get Conversations

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.creatyvot.com/v1/conversations',
    headers=headers,
    params={'limit': 10, 'status': 'active'}
)

conversations = response.json()

Create Contact

cURL

curl -X POST https://api.creatyvot.com/v1/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+1234567890",
    "name": "John Doe",
    "email": "[email protected]",
    "tags": ["customer", "vip"]
  }'

Official SDKs

JavaScript/Node.js

v2.1.0

Official SDK for Node.js and browser environments

npm install @creatyvot/sdk

Features:

  • TypeScript support
  • Promise-based
  • Error handling

Python

v1.8.0

Python SDK for easy integration

pip install creatyvot-sdk

Features:

  • Async support
  • Pandas integration
  • Jupyter notebooks

PHP

v1.5.0

PHP SDK with Laravel support

composer require creatyvot/php-sdk

Features:

  • Laravel integration
  • Guzzle HTTP client
  • PSR-4 compliant

Java

v1.3.0

Java SDK for high-scale applications

Maven dependency

Features:

  • Spring Boot support
  • Async operations
  • Comprehensive logging

Webhooks

Receive real-time notifications about events in your Creatyvot account. Configure webhooks to automatically trigger actions in your systems when messages are received, conversations are updated, and more.

Supported Events:

message.received
message.delivered
conversation.created
conversation.assigned
contact.created
agent.status_changed

Rate Limits

To ensure fair usage and system stability, we implement rate limits on our API endpoints.

100

Basic

requests per minute

1000

Growth

requests per minute

5000+

Ultimate

requests per minute

Ready to Build?

Start integrating Creatyvot into your applications and workflows today.

Get StartedContact Support