Jump to Content
Home
Guides
API Reference
Changelog
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Jump to Content
Home
Guides
API Reference
Changelog
Voice Chat + Speaking Avatar via API
Search
Ask AI
Log In
Moon (Dark Mode)
Sun (Light Mode)
All
Pages
Start typing to search…
JUMP TO
Getting Started
Introduction
CustomGPT.ai API
API Keys and Authentication
API Use Cases
API Tutorial Example
Shopify Order Lookup with CustomGPT.ai API
Know which document or source gets most hits via API
Use n8n or make.com module with our API
CRM integration (external_id)
Upload multiple documents at once via API
Chrome Extension Chat via API
Voice Chat + Speaking Avatar via API
Social Media Chat Bots via API
How to Show Sources Without Exposing Files using API?
Python Library
CustomGPT's Official Python Library
OpenAI SDK Compatability
CustomGPT.ai OpenAI SDK Compatibility (Beta)
Model Context Protocol (MCP)
CustomGPT.ai Hosted MCP Server
Claude Desktop
Claude Web
ChatGPT
Cursor
Windsurf
Trae
Other Clients
CustomGPT.ai
Pages
List all pages that belong to an agent.
get
Delete a certain page that belongs to a certain agent.
del
Reindex a certain page that belongs to a certain agent.
post
Preview file from citation.
get
Users
Show the user's profile.
get
Update the user's profile.
post
Search for a team member.
get
Agent Settings
Get agent settings.
get
Update agent settings.
post
Conversations
List all conversations for an agent (formerly known as project).
get
Create a new conversation.
post
Update a conversation.
put
Delete a conversation.
del
Retrieve messages that have been sent in a conversation.
get
Send a message to a conversation.
post
Send a message to a conversation in openai format.
post
Citations
Get the Open Graph data for a citation.
get
Agents
List all agents.
get
Create a new agent.
post
Show a certain agent.
get
Update a certain agent.
post
Delete a certain agent.
del
Replicate agent by given ID.
post
Get the stats for a certain agent.
get
Pages Metadata
Get the Metadata for a certain page.
get
Update metadata for a certain page.
put
Message
Get a message by message ID
get
Update the reaction for a specific message
put
Sources
List a certain agent's sources.
get
Create a new agent source.
post
Update agent source settings.
put
Delete an agent source.
del
Instant sync the specified sitemap
put
Reports & Analytics
Provide summary of various metrics of users interactions with the application.
get
Provide summary of overall query metrics accross all conversations.
get
Provide summary of overall conversation metrics.
get
Provide graph-ready analysis data of various metrics.
get
Agent Licenses
Get all licenses for an agent
get
Create a new license for an agent
post
Get a license for an agent
get
Update a license for an agent
put
Delete a license for an agent
del
Limits
Get user's agents, words and queries limit.
get
Customer Intelligence
Get customer intelligence analytics data for a project.
get
SUPPORT
Error Handling
Terminology
Starter Kit Using APIs
Open Source Chat UI with Project Settings
Widget - Embed on Site
Widget - Floating Chatbot
Social Media Bots
Telegram Bot using APIs
Discord Bot using APIs
Slack Bot using APIs
Whatsapp Bot using APIs and Twilio
Powered by
Ask AI
Voice Chat + Speaking Avatar via API
coming soon
