API Overview
The Charp.ai platform provides a structured API set for vendors to manage brands, campaigns, and related tools. This section outlines the primary API categories and their core functionalities.
API Structure
Our API ecosystem is organized into five main categories, each serving a specific purpose in the vendor workflow:
Available APIs
Vendor API
Vendor API
The Vendor API manages vendor accounts and details.
- Vendors can view their details and update minor information
- When a vendor is created, they receive:
- Client ID & Secret Key (for authentication)
- Plan details (Free, Standard, Enterprise)
- Account limits & credit system (if applicable)
Authentication API
Authentication API
The Authentication API handles secure access to the platform.
- Standard OAuth2-based authentication
- Vendors can generate an access token using their Client ID and Secret
- This token is required to access Campaign and Tools APIs
Brand API
Brand API
The Brand API enables management of brand entities.
- Vendors manage brands (companies they handle customers for)
- Provides CRUD operations for brand management
Campaign API
Campaign API
The Campaign API facilitates campaign creation and management.
- Vendors create and manage campaigns for a specific brand
- Campaign operations include:
- Data Ingestion (uploading and processing campaign data)
- Callback & Egress API (for data delivery)
- Start/Stop Campaign (control campaign execution)
- Campaign Scheduling (set time slots for execution)
- Campaign Insights (fetch campaign performance data)
Tools API
Tools API
The Tools API provides specialized utilities for campaign enhancement.
- Provides additional tools for vendors to enhance campaign execution
- APIs for data transformation, media processing, and analytics
- Includes functionality for TTS, voice cloning, lip sync, and face swap
API Access by Plan
Different vendor plans provide varying levels of access to our API ecosystem:
Free
Basic access to Brand and Campaign APIs with limited requests
Standard
Full access to Brand, Campaign, and basic Tools APIs
Enterprise
Unlimited access to all APIs with premium support
Next Steps
Proceed to the API Authentication Flow section to learn how to authenticate and start using our APIs.
API Overview
The Charp.ai platform provides a structured API set for vendors to manage brands, campaigns, and related tools. This section outlines the primary API categories and their core functionalities.
API Structure
Our API ecosystem is organized into five main categories, each serving a specific purpose in the vendor workflow:
Available APIs
Vendor API
Vendor API
The Vendor API manages vendor accounts and details.
- Vendors can view their details and update minor information
- When a vendor is created, they receive:
- Client ID & Secret Key (for authentication)
- Plan details (Free, Standard, Enterprise)
- Account limits & credit system (if applicable)
Authentication API
Authentication API
The Authentication API handles secure access to the platform.
- Standard OAuth2-based authentication
- Vendors can generate an access token using their Client ID and Secret
- This token is required to access Campaign and Tools APIs
Brand API
Brand API
The Brand API enables management of brand entities.
- Vendors manage brands (companies they handle customers for)
- Provides CRUD operations for brand management
Campaign API
Campaign API
The Campaign API facilitates campaign creation and management.
- Vendors create and manage campaigns for a specific brand
- Campaign operations include:
- Data Ingestion (uploading and processing campaign data)
- Callback & Egress API (for data delivery)
- Start/Stop Campaign (control campaign execution)
- Campaign Scheduling (set time slots for execution)
- Campaign Insights (fetch campaign performance data)
Tools API
Tools API
The Tools API provides specialized utilities for campaign enhancement.
- Provides additional tools for vendors to enhance campaign execution
- APIs for data transformation, media processing, and analytics
- Includes functionality for TTS, voice cloning, lip sync, and face swap
API Access by Plan
Different vendor plans provide varying levels of access to our API ecosystem:
Free
Basic access to Brand and Campaign APIs with limited requests
Standard
Full access to Brand, Campaign, and basic Tools APIs
Enterprise
Unlimited access to all APIs with premium support
Next Steps
Proceed to the API Authentication Flow section to learn how to authenticate and start using our APIs.