Jump to Content
Home
Guides
API Reference
Changelog
API Reference
Log In
Jump to Content
Home
Guides
API Reference
Changelog
Widget - Embed on Site
Log In
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
Social Media Chat Bots via API
How to Show Sources Without Exposing Files using API?
API Integration (Social bots and snippets)
Telegram RAG AI Bot using APIs
Discord RAG AI Bot using APIs
Slack RAG AI Bot using APIs
WhatsApp RAG AI Bot using APIs
Facebook RAG AI Bot using APIs
Instagram RAG AI Bot using APIs
Rocket Chat RAG AI Bot using APIs
MS Teams RAG AI Bot using APIs
Google Chat RAG AI bot using APIs
Chrome Extension Chat using API
Chat Widget - Next.js Version
Chat Widget - Python + Vue
n8n, make.com http module via 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
SUPPORT
Error Handling
Terminology
Starter Kit Using APIs
Open Source Chat UI with Project Settings
Widget - Embed on Site
Widget - Floating Chatbot
Docs MCP Server
Docs MCP Server
CustomGPT.ai
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
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
List labels attached to a page.
get
Replace labels on a page with the provided set of label IDs.
put
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
List persona version history
get
Get persona version details
get
Update the active persona for an agent.
put
Conversations
Send a message to a conversation in openai format.
post
List all conversations for an agent (formerly known as project).
get
Create a new conversation.
post
Export a conversation.
get
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
Citations
Get the Open Graph data for a citation.
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
Get claims by message ID
get
Get trust score by message ID
get
Verify Response for a prompt
post
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
Get customer intelligence analytics data for a project.
get
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
Provide Project Leads Export
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
Labels
List labels with users for a project.
get
Create labels within a project (bulk).
post
Upsert label-user mappings for a project.
put
Delete specific users from labels for a project.
del
Delete a label (project-scoped) and remove all related mappings: - project_label_users - page_labels (for pages in this project)
del
Get a single label (with assigned users) for a project.
get
Rename a label in a project.
put
Powered by
Widget - Embed on Site
Ask AI
