CustomGPT.ai
RAG API with RESTful endpoints, comprehensive SDKs, and enterprise-grade reliability.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
RAG API with RESTful endpoints, comprehensive SDKs, and enterprise-grade reliability.
Endpoints 124
Agents
- GETList or export activity summaries for an authorized agent.
/api/v1/projects/:projectId/activity-logs - GETList all agents.
/api/v1/projectsReturns all agents in your account, sorted by creation date with the most recent first. Use this endpoint to get an overview of your agents or to retrieve… - POSTCreate an agent.
/api/v1/projectsCreates a new agent by importing content from a sitemap URL or uploading a file. The imported content becomes the agent's knowledge base, which it uses to… - GETGet agent details.
/api/v1/projects/:projectIdReturns the full configuration and current status for a specific agent. Use this to check processing status, view settings, or retrieve metadata about the… - POSTUpdate an agent.
/api/v1/projects/:projectIdUpdates an existing agent's name or configuration settings. Use this to rename an agent or modify its basic properties without affecting its knowledge base. - DELETEDelete an agent.
/api/v1/projects/:projectIdPermanently deletes an agent and all associated data, including its knowledge base, conversations, settings, and analytics. This action cannot be undone.… - POSTReplicate an agent.
/api/v1/projects/:projectId/replicateCreates a complete copy of an existing agent, including its knowledge base, persona, and settings. Use this to create variations of an agent for testing, or… - GETGet agent statistics.
/api/v1/projects/:projectId/statsReturns usage metrics and performance statistics for an agent, including total conversations, query counts, document statistics, and processing information.…
Pages
- GETList all documents.
/api/v1/projects/:projectId/pagesReturns all indexed documents in an agent's knowledge base. Each document represents a piece of content (webpage, PDF, uploaded file) that the agent can… - DELETEDelete a document.
/api/v1/projects/:projectId/pages/:pageIdPermanently removes a document from an agent's knowledge base. The agent will no longer reference this content when answering questions. Use this to remove… - POSTReindex a document.
/api/v1/projects/:projectId/pages/:pageId/reindexRe-crawls and re-indexes a document to update its content in the knowledge base. Use this when the source content has changed and you want the agent to use… - GETGet document labels.
/api/v1/projects/:projectId/pages/:pageId/labelsReturns all labels assigned to a document. Labels control which users can access answers derived from this document - users only see answers from documents… - PUTReplace document labels.
/api/v1/projects/:projectId/pages/:pageId/labelsAssigns labels to a document for access control. The provided label IDs replace any existing labels on the document. To remove all labels (making the document… - GETGet citation source preview.
/api/v1/preview/:pageIdReturns a preview of the source document referenced by a citation. Use this to show users the original content that the agent used to generate a response.
Users
- GETList personal activity summaries or export the full matching history.
/api/v1/activity-logs - GETRetrieve masked activity details with UI-equivalent authorization.
/api/v1/activity-logs/:logId - GETGet current user profile.
/api/v1/userReturns profile information for the currently authenticated user, including account details and settings. - POSTUpdate user profile.
/api/v1/userUpdates profile settings for the currently authenticated user. Use this to modify account preferences or personal information. - GETSearch team members.
/api/v1/user/search-team-memberSearches for team members by email address or user ID. Use this to find users when assigning permissions or managing team access. Notes: Requires Owner or…
Agent Settings
- GETGet agent settings.
/api/v1/projects/:projectId/settingsReturns the complete configuration for an agent, including persona instructions, response behavior, deployment options, and feature flags. Use this to review… - POSTUpdate agent settings.
/api/v1/projects/:projectId/settingsUpdates an agent's configuration, including persona instructions, response format, citation style, and deployment settings. Notes: Only include the fields you… - GETList persona versions.
/api/v1/projects/:projectId/settings/personasReturns the version history of an agent's persona. Every time the persona is updated, a snapshot is automatically saved, allowing you to view changes over… - GETGet persona version.
/api/v1/projects/:projectId/settings/persona/:versionReturns the full text and metadata for a specific persona version. Use this to compare versions or review what instructions were active at a particular time. - GETList sub-personas.
/api/v1/projects/:projectId/settings/persona/:version/sub-personasReturns generated sub-personas for one persona version and project-level overrides separately. - DELETEDelete sub-persona override.
/api/v1/projects/:projectId/settings/persona/:version/sub-personas/:slugDeletes the project-level override for one sub-persona slug. Generated persona-version rows are not modified. - PATCHUpdate sub-persona override.
/api/v1/projects/:projectId/settings/persona/:version/sub-personas/:slugCreates or updates the project-level override for one sub-persona slug. Generated persona-version rows are not modified. - PUTActivate a persona version.
/api/v1/projects/:projectId/settings/persona-activate/:versionActivates a previous persona version, making it the current active persona. This creates a new version entry in the history (it doesn't overwrite), preserving… - GETList skill versions.
/api/v1/projects/:projectId/settings/personas/skills/:skillId/versionsReturns the version history of one skill, newest first. - GETGet skill version.
/api/v1/projects/:projectId/settings/personas/skills/:skillId/versions/:versionReturns the full text and metadata of one version of a skill. - PUTRestore skill version.
/api/v1/projects/:projectId/settings/personas/skills/:skillId/versions/:version/activateMakes one version of a skill the live skill body again.
Conversations
- POSTSend message (OpenAI format).
/api/v1/projects/:projectId/chat/completionsSends a message using the OpenAI-compatible request and response format. Use this if you are migrating from OpenAI or want to use existing OpenAI client… - GETList conversations.
/api/v1/projects/:projectId/conversationsReturns all conversations for an agent. Each conversation represents a chat session with a user and contains the full message history. Results are paginated… - POSTCreate a conversation.
/api/v1/projects/:projectId/conversationsCreates a new conversation session for an agent. Returns a session ID that you'll use to send messages. You can optionally provide a name to help identify the… - GETExport conversation.
/api/v1/projects/:projectId/conversations/:sessionId/exportExports the complete conversation history (all prompts and agent responses) as a downloadable file. Use this to archive conversations, share transcripts, or… - PUTUpdate conversation.
/api/v1/projects/:projectId/conversations/:sessionIdUpdates conversation metadata, such as the display name. Use this to rename conversations for easier organization and identification. - DELETEDelete conversation.
/api/v1/projects/:projectId/conversations/:sessionIdPermanently deletes a conversation and all its messages. Use this to remove sensitive conversations or clean up test data. Warning: This action cannot be… - GETGet conversation messages.
/api/v1/projects/:projectId/conversations/:sessionId/messagesReturns all messages in a conversation, including user prompts, agent responses, timestamps, and citations. Use this to display conversation history or… - POSTSend message.
/api/v1/projects/:projectId/conversations/:sessionId/messagesSends a user message to an agent and returns the agent's response. Supports streaming for real-time display, file attachments for document analysis, and…
Tasks
- GETList tasks.
/api/v1/projects/:projectId/tasksReturns all Plan & Act mode tasks for an agent, paginated. Tasks are ordered by most recent activity. - POSTCreate task.
/api/v1/projects/:projectId/tasksCreates a Plan & Act task and submits its first prompt in one call. Returns 202 Accepted. Sessions can run for minutes or longer, so callers must poll GET… - GETPoll task.
/api/v1/projects/:projectId/tasks/:taskIdReturns the current processing state of a task. While the task is running, returns status: processing with any stream events flushed since the last poll. When… - PUTUpdate task.
/api/v1/projects/:projectId/tasks/:taskIdUpdates task metadata, such as the display name. Use this to rename tasks for easier organization and identification. The display name is the only mutable… - DELETEDelete task.
/api/v1/projects/:projectId/tasks/:taskIdPermanently deletes a task and all its messages. Use this to remove sensitive tasks or clean up test data. Warning: This action cannot be undone. All messages… - GETExport task.
/api/v1/projects/:projectId/tasks/:taskId/exportExports the full task conversation history (all prompts and agent responses) as a downloadable file. The file format is selected by the format query parameter.
Citations
- GETGet citation metadata.
/api/v1/projects/:projectId/citations/:citationIdReturns metadata for a specific citation, including the source document's title, description, URL, and preview information. Use this to display source…
Teams
- GETList all teams the authenticated user belongs to.
/api/v1/teamsReturns a paginated list of all teams the authenticated user is a member of. - PUTUpdate a team name.
/api/v1/teamsUpdates the name of a team. Only the team owner or a member with the update permission can perform this action. - POSTSwitch active team.
/api/v1/teams/:teamId/switchSwitches the authenticated user's active team context. Subsequent requests will operate in the context of the new team.
Team Members
- GETList team members.
/api/v1/teams/membersReturns a paginated list of all members belonging to the specified team, including their assigned roles. - PUTUpdate a team member's role.
/api/v1/teams/members/:userIdChanges the role assigned to a team member. Only the team owner or a member with the appropriate permission can perform this action. - DELETERemove a team member.
/api/v1/teams/members/:userIdRemoves a member from the team. Only the team owner or a member with the appropriate permission can perform this action.
Team Invitations
- GETList pending invitations.
/api/v1/teams/invitationsReturns a paginated list of all pending invitations for the specified team. - POSTInvite a new member.
/api/v1/teams/invitationsSends an invitation email to the specified address. The recipient must accept the invitation before they become a team member. - POSTResend an invitation.
/api/v1/teams/invitations/:invitationId/resendCancels the existing invitation and sends a new one to the same email address with the same role. - DELETECancel an invitation.
/api/v1/teams/invitations/:invitationIdCancels a pending team invitation. The invited person will no longer be able to join via this invitation link.
Team Roles
- GETList roles.
/api/v1/teams/rolesReturns all roles that can be assigned to members within this team. Includes both global assignable system roles (Administrator, Member, Chat-only) and the… - POSTCreate a custom role.
/api/v1/teams/rolesCreates a new custom role for the team with the specified permissions. Role names cannot match reserved role names (Owner, Administrator, Member). - PUTUpdate a custom role.
/api/v1/teams/roles/:roleIdUpdates an existing custom role's name, description, and permissions. Only roles belonging to this team can be updated. - DELETEDelete a custom role.
/api/v1/teams/roles/:roleIdDeletes a custom role belonging to this team. Reserved system roles cannot be deleted, and a role cannot be deleted while it still has members assigned, has…
Webpage Awareness
- GETList webpage context pages.
/api/v1/projects/:projectId/contextual-rag/pagesReturns all webpage context entries for an agent, with optional URL filtering and pagination. Requires the Webpage Awareness tool to be enabled on the agent. - DELETEDelete webpage context pages.
/api/v1/projects/:projectId/contextual-rag/pagesDeletes webpage context entries for an agent. Pass page_ids to delete specific pages, or omit the body to delete all pages for the agent. Requires the Webpage… - PATCHBulk update page messages.
/api/v1/projects/:projectId/contextual-rag/messagesUpdates auto_message and/or display_message for one or more webpage context entries. Requires the Webpage Awareness tool to be enabled on the agent.
Pages Metadata
- GETGet document metadata.
/api/v1/projects/:projectId/pages/:pageId/metadataReturns metadata for a document, including its title, source URL, word count, and any custom metadata fields. Use this to display document information or… - PUTUpdate document metadata.
/api/v1/projects/:projectId/pages/:pageId/metadataUpdates custom metadata fields for a document. Use this to add tags, categories, or other organizational information that helps manage your knowledge base.
Deployment Settings
- GETGet deployment settings.
/api/v1/projects/:projectId/deploymentReturns all deployment section configurations (embed, live_chat, ai_assistant, instant_viewer, sge) for an agent. Missing settings are returned with their… - PATCHUpdate deployment settings.
/api/v1/projects/:projectId/deployment/:sectionUpdates a single deployment section for an agent. The section path parameter identifies which section to update (embed, live_chat, ai_assistant,…
Agent Actions
- GETList agent actions.
/api/v1/projects/:projectId/actions - POSTCreate a custom action (MCP).
/api/v1/projects/:projectId/actions/custom - PUTUpdate a custom action configuration.
/api/v1/projects/:projectId/actions/custom/:actionKey - DELETEDelete a custom action.
/api/v1/projects/:projectId/actions/custom/:actionKey - PUTUpdate built-in action settings.
/api/v1/projects/:projectId/actions/builtin/:actionKey/settings - GETList the agent's custom External APIs.
/api/v1/projects/:projectId/actions/external-apis - POSTAdd a custom External API.
/api/v1/projects/:projectId/actions/external-apisCreates the connection from an OpenAPI schema, given as an uploaded file or an HTTPS URL. The agent calls it only while Plan & Act and Smart Tasks are enabled… - GETGet a custom External API.
/api/v1/projects/:projectId/actions/external-apis/:integrationId - PUTUpdate a custom External API.
/api/v1/projects/:projectId/actions/external-apis/:integrationIdRenames it, replaces its API key, or enables/disables it. At most 5 External APIs can be active at once. - DELETEDelete a custom External API.
/api/v1/projects/:projectId/actions/external-apis/:integrationId - POSTReplace a custom External API's OpenAPI schema.
/api/v1/projects/:projectId/actions/external-apis/:integrationId/openapiTakes the same openapi_url (JSON) or openapi_file (multipart/form-data) field as create; exactly one of them is required.
Multi-Agent
- GETList child agents.
/api/v1/projects/:projectId/childrenReturns all agents currently assigned to this Multi-Agent, including their name and generation flag. - POSTAssign child agents.
/api/v1/projects/:projectId/childrenAssigns one or more agents as children of this Multi-Agent. Enforces plan limits, team ownership, and prevents assigning Multi-Agent projects as children. - DELETEBulk unassign child agents.
/api/v1/projects/:projectId/childrenRemoves multiple child agents from this Multi-Agent in a single request. Returns 422 if the operation would leave no children, or if any specified agent is… - DELETEUnassign a child agent.
/api/v1/projects/:projectId/children/:childProjectIdRemoves a single child agent from this Multi-Agent. Returns 422 if this is the last remaining child, or 404 if the agent is not currently assigned.
Tags
- GETList all tags.
/api/v1/projects/:projectId/labelsReturns all tags configured for an agent, along with the users assigned to each tag. Use this to review your access control configuration or build a tag… - PUTAssign users to a tag.
/api/v1/projects/:projectId/labelsSets which users are assigned to each tag. The provided user list becomes the source of truth - users not included in the list are removed from that tag, and… - POSTCreate tags.
/api/v1/projects/:projectId/labelsCreates one or more new tags for document access control. Accepts an array of tag names, allowing bulk creation. After creating tags, assign them to documents… - GETGet tag details.
/api/v1/projects/:projectId/labels/:labelIdRetrieves a specific tag, including its name and the list of users assigned to it. Tags are called *labels* in the API, so paths and fields use label (for… - PUTUpdate a tag name.
/api/v1/projects/:projectId/labels/:labelIdUpdates the name of an existing tag. User and document assignments are preserved. Tags are called *labels* in the API, so paths and fields use label (for… - DELETEDelete a tag.
/api/v1/projects/:projectId/labels/:labelIdPermanently deletes a tag and removes all associated assignments (both user-to-tag and document-to-tag mappings). Documents that lose their only tag will… - DELETERemove users from tags.
/api/v1/projects/:projectId/labels/usersRemoves specific users from one or more tags without affecting other users' assignments. Use this when offboarding users or revoking access to specific…
Message
- GETGet message details.
/api/v1/projects/:projectId/conversations/:sessionId/messages/:promptIdReturns the complete details for a single message, including the user's prompt, the agent's response, timestamps, citations, and any attached metadata. Use… - PUTUpdate message feedback.
/api/v1/projects/:projectId/conversations/:sessionId/messages/:promptId/feedbackRecords user feedback (thumbs up/down) for a message. Use this to collect quality signals that help identify which responses are helpful and which need… - GETGet message claims.
/api/v1/projects/:projectId/conversations/:sessionId/messages/:promptId/claimsReturns the factual claims extracted from an agent's response. Each claim is a discrete statement that can be independently verified against the source… - GETGet message trust score.
/api/v1/projects/:projectId/conversations/:sessionId/messages/:promptId/trust-scoreReturns a verification trust score for a message, calculated by checking how well the agent's claims are supported by the source documents. Higher scores… - POSTVerify message accuracy.
/api/v1/projects/:projectId/conversations/:sessionId/messages/:promptId/verifyTriggers a fact-checking verification process for a message's claims. The system compares each claim against the source documents and reports which claims are…
Task Messages
- POSTSubmit tool outputs.
/api/v1/projects/:projectId/tasks/:taskId/tool-outputsResumes a task paused on awaiting_tool_results by submitting the results of the function calls requested by the agent. All pending tool_call_ids must be… - POSTStop response.
/api/v1/projects/:projectId/tasks/:taskId/stopStops the response a task is currently generating. Whatever already ran is still saved and billed, and the plan is parked so the next message can pick it up.… - GETList task messages.
/api/v1/projects/:projectId/tasks/:taskId/messagesReturns all messages in a task, including user prompts, agent responses, timestamps, and citations. Use this to display task history or analyze past… - POSTSend follow-up message.
/api/v1/projects/:projectId/tasks/:taskId/messagesSubmits a follow-up prompt to an existing task. The task must not currently be processing a previous message. Returns 202 Accepted; poll the task for… - GETGet task message.
/api/v1/projects/:projectId/tasks/:taskId/messages/:promptHistoryIdReturns the complete details for a single message, including the user's prompt, the agent's response, timestamps, citations, and any attached metadata. Use…
Task Files
- GETList message files.
/api/v1/projects/:projectId/tasks/:taskId/messages/:promptHistoryId/filesReturns all files associated with a specific task message - both user-uploaded sources and AI-generated artifacts. Use the type field to distinguish between… - GETDownload message file.
/api/v1/projects/:projectId/tasks/:taskId/messages/:promptHistoryId/files/:fileId/downloadGenerates a pre-signed URL for an agent-generated artifact and redirects to it. The redirect target is valid for 1 hour. - DELETEDelete message file.
/api/v1/projects/:projectId/tasks/:taskId/messages/:promptHistoryId/files/:fileIdDeletes an agent-generated artifact from a task message.
Sources
- GETList sources.
/api/v1/projects/:projectId/sourcesReturns all data sources connected to an agent. Each source represents an origin for documents - such as a sitemap, Google Drive folder, SharePoint site, or… - POSTAdd a source.
/api/v1/projects/:projectId/sourcesConnects a new data source to an agent's knowledge base. You can add content via sitemap URL, file upload, or integration connection (Google Drive,… - PUTUpdate source settings.
/api/v1/projects/:projectId/sources/:sourceIdUpdates configuration for a data source, such as auto-sync frequency, crawl depth, or file filters. Use this to fine-tune how the source is indexed and kept… - DELETEDelete a source.
/api/v1/projects/:projectId/sources/:sourceIdRemoves a data source and all its documents from an agent's knowledge base. Use this to disconnect content that's no longer relevant or to clean up after… - PUTTrigger instant source sync.
/api/v1/projects/:projectId/sources/:sourceId/instant-syncTriggers an immediate re-sync of a data source, refreshing all its documents with the latest content. Use this when you know the source has been updated and…
Reports & Analytics
- GETGet customer intelligence.
/api/v1/projects/:projectId/reports/intelligenceReturns AI-analyzed insights about your users, including common intents, emotional sentiment, frequently discussed topics, and emerging trends. Use this to… - GETGet traffic analytics.
/api/v1/projects/:projectId/reports/traffic?filters=sourcesReturns a breakdown of conversation volume by deployment channel (e.g. web widget, API, Slack, WhatsApp) over the requested time window. Use the filters query… - GETGet query analytics.
/api/v1/projects/:projectId/reports/queries?filters=totalReturns aggregate query metrics, including total query volume, success rates, average response times, and failure reasons. Use this to monitor agent… - GETGet conversation analytics.
/api/v1/projects/:projectId/reports/conversations?filters=totalReturns conversation metrics, including total conversations, average duration, messages per conversation, and completion rates. Use this to understand how… - GETGet analytics chart data.
/api/v1/projects/:projectId/reports/analysis?filters=queriesReturns time-series data formatted for charts, with daily, weekly, or monthly breakdowns of key metrics. - GETExport leads.
/api/v1/projects/:projectId/reports/leadsExports lead information captured from conversations, including email addresses, names, and any custom fields collected. Use this to sync leads with your CRM… - GETExport leads for a conversation.
/api/v1/projects/:projectId/reports/leads/:sessionId/exportExports every lead captured in a conversation as a downloadable file in the requested format. - GETExport a single collated lead for a conversation.
/api/v1/projects/:projectId/reports/leads/:sessionId/collatedReturns one merged lead built from all lead rows in the conversation.
Agent Licenses
- GETList licenses.
/api/v1/projects/:projectId/licensesReturns all access licenses configured for an agent. Licenses control who can interact with the agent and what permissions they have. Use this to manage… - POSTCreate a license.
/api/v1/projects/:projectId/licensesCreates a new access license for an agent with specified permissions and optional expiration. Use this to grant controlled access to external users or systems. - GETGet license details.
/api/v1/projects/:projectId/licenses/:licenseIdReturns the full details for a specific license, including permissions, usage statistics, status, and expiration date. Use this to audit or troubleshoot… - PUTUpdate a license.
/api/v1/projects/:projectId/licenses/:licenseIdUpdates a license's settings, such as permissions, expiration date, or active status. Use this to modify access without creating a new license. - DELETEDelete a license.
/api/v1/projects/:projectId/licenses/:licenseIdRevokes and permanently removes an access license. Any users or systems using this license will immediately lose access to the agent. Warning: This…
Limits
- GETGet account limits.
/api/v1/limits/usageReturns your current usage and plan limits for agents, storage (words), and monthly queries. Use this to monitor consumption, plan for scaling, or display…
Billing
- GETGet current plan details.
/api/v1/billing/planReturns the active subscription plan for your account, including billing cycle dates, trial status, plan options, and active addons. Returns null data when no… - GETList payment methods.
/api/v1/billing/payment-methodsReturns all payment methods attached to your account, including type, display name, card details, and which is the default. - GETList invoices.
/api/v1/billing/invoicesReturns paginated invoices for your account. Invoice records are stored locally and do not require a Stripe API call. Use the page and limit query parameters… - GETDownload an invoice.
/api/v1/billing/invoices/:invoiceId/downloadReturns the Stripe-hosted PDF for the specified invoice. The invoice ID must belong to your account.
API details
- Base URL
https://app.customgpt.ai- Authentication
- A bearer token in the Authorization header
- Operations
- 124 operations on 88 pathsGET 60POST 25PUT 18DELETE 18PATCH 3
- Main resources
- Agent Actions 11Agent Settings 11Agents 8Conversations 8Reports & Analytics 8Tags 7Pages 6Tasks 6Agent Licenses 5Message 5
- Response formats
application/json- Description format
- OpenAPI 3.0.2, API version
1.0.0 - Links
- OpenAPI document · Support
- Listed from
- Customgpt's published OpenAPI description
How to test the CustomGPT.ai in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the CustomGPT.ai collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List or export activity summaries for an authorized agent.” (GET /api/v1/projects/:projectId/activity-logs), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the CustomGPT.ai?
RAG API with RESTful endpoints, comprehensive SDKs, and enterprise-grade reliability. It is listed under AI & machine learning and has 124 endpoints.
Who publishes the CustomGPT.ai?
It is listed from CustomGPT.ai's public API description (an OpenAPI document), not published by CustomGPT.ai on Swastik Codes. Anyone who controls customgpt.ai can claim the profile by adding a DNS TXT record.
What is the base URL of the CustomGPT.ai?
Requests go to https://app.customgpt.ai. Endpoint paths are added to this base URL.
How do I authenticate with the CustomGPT.ai?
With A bearer token in the Authorization header.
How many endpoints does the CustomGPT.ai have?
124 operations on 88 paths (60 GET, 25 POST, 18 PUT, 18 DELETE, 3 PATCH). The largest groups are Agent Actions, Agent Settings, Agents, Conversations.
Is forking the CustomGPT.ai free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.