Skip to main content
Customgpt logo
  • Category: ai chatbots
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 40
  • Triggers: 0
  • Slug: CUSTOMGPT
  • Version: 20261101_00

Tools

Slug: CUSTOMGPT_ACTIVATE_PERSONA_VERSIONRestore a previous persona version for a CustomGPT agent. Activates a previous persona version, making it the current active persona. This creates a new version entry in the history (it doesn’t overwrite), preserving the full audit trail. Use this to roll back to a known-good configuration. Requires Custom plan.

Input Parameters

integer
required
The version number of the persona to activate. This must be a valid version from the persona history.
integer
required
The unique identifier of the agent (formerly known as project). Obtain this from the List Projects action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_ADD_SOURCEAdd a data source to a CustomGPT agent’s knowledge base using a sitemap URL or file upload. Use this to add documentation, FAQs, or other knowledge content to an agent.

Input Parameters

object
File to upload as a source (PDF, DOC, TXT, etc.). Required if sitemap_path is not provided.
integer
required
The unique identifier of the agent (formerly known as project) to add the source to.
string
URL of the sitemap to use as a source (e.g., ‘https://docs.example.com/sitemap.xml’). Required if file is not provided.
boolean
Whether to anonymize the data in the source.
boolean
Whether to enable OCR (Optical Character Recognition) for extracting text from images in the file.
boolean
Whether to enable vision processing for images in the file source. Allows the agent to analyze and understand image content.
boolean
Whether to retain file data after processing.
string ("none" | "sync_from_sitemap")
Type of image extraction from website.
boolean
Whether to compress images for vision processing. Reduces storage and improves performance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_CLONE_PROJECTTool to clone a CustomGPT agent (project). Creates 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 to use an existing agent as a template for a new one.

Input Parameters

integer
required
The unique agent identifier of the project to clone

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_CREATE_CONVERSATIONTool to create a new conversation session for a CustomGPT agent. Use this when starting a new chat interaction - it returns a session ID that you’ll use to send messages. Optionally provide a name to help identify the conversation later.

Input Parameters

string
Optional name to identify the conversation. Helps organize and reference conversations later. If not provided, a default name will be assigned.
integer
required
The unique identifier of the agent (formerly known as project). Obtain this from the List Projects action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_CREATE_PROJECTCreate a new CustomGPT agent from either a sitemap URL or a file upload. Exactly one source must be provided; the agent processes the content to build its knowledge base.

Input Parameters

object
File to upload for the agent’s knowledge base. Either file or sitemap_path must be provided, not both.
string
required
Name for the new agent. This will be the display name of the agent.
string
URL of sitemap to import content from. The agent will crawl and index content from this sitemap. Either sitemap_path or file must be provided, not both.
boolean
Whether to anonymize data in the agent’s knowledge base. Use this to protect sensitive information.
boolean
Whether to enable OCR (Optical Character Recognition) for extracting text from images and scanned documents.
boolean
Whether to enable vision processing for images in the file source. Allows the agent to process and understand images.
boolean
Whether to retain file data after processing. If false, only extracted text is kept.
boolean
Whether to compress images for vision processing. Reduces storage and processing costs for image-heavy content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_DELETE_PAGETool to delete a document from a CustomGPT agent’s knowledge base. Permanently removes a document and the agent will no longer reference this content when answering questions. Use this to remove outdated or incorrect information. Warning: This action cannot be undone.

Input Parameters

integer
required
The page id
integer
required
The unique identifier of the agent (formerly known as project).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_DELETE_PROJECTTool to delete a CustomGPT project by ID. Use when you need to permanently remove an existing agent after confirming the ID.

Input Parameters

string
required
Unique ID of the agent (project) to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_DELETE_PROJECT_LICENSEDelete a license from a CustomGPT project or agent using its numeric project ID and license ID. The operation succeeds if the license is already absent.

Input Parameters

string
required
Unique identifier of the license to delete from the project
string
required
Numeric ID of the CustomGPT agent/project (as string, e.g., ‘90631’). The API requires integer-formatted project IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_DELETE_SOURCETool to delete a data source from a CustomGPT agent. Removes the source and all its documents from the agent’s knowledge base. Use this to disconnect content that’s no longer relevant or to clean up after testing.

Input Parameters

integer
required
The unique identifier of a source to delete.
integer
required
The unique identifier of the agent (formerly known as project).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_EXPORT_LEADSExport leads from a CustomGPT project. Returns lead information captured from conversations including email addresses, names, phone numbers, and custom fields. Supports pagination and date range filtering. Use this to sync leads with CRM or marketing tools.

Input Parameters

integer
Page number for pagination (≥1). If not specified, returns the first page.
integer
Number of items per page (1-500). Defaults to 100 if not specified.
string
End date for filtering leads (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’). Only leads up to this date will be included.
integer
required
The unique ID of the project to export leads from.
string
Start date for filtering leads (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’). Only leads from this date onwards will be included.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_MESSAGETool to get message details from a CustomGPT conversation. Returns the complete details for a single message, including the user’s prompt, the agent’s response, timestamps, citations, and any attached metadata.

Input Parameters

integer
required
The message id of the message
integer
required
The ID of the agent to get the message for
string
required
The session ID of the conversation to get the message from
array
Fields to expand in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_MESSAGE_TRUST_SCORERetrieves verification trust assessment data for a message in a CustomGPT conversation. The result can include an overall status and stakeholder evaluations; trust data may be absent.

Input Parameters

integer
required
The message ID of the message to get the trust score for.
integer
required
The ID of the agent to get the message trust score for.
string
required
The session ID of the conversation containing the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_PAGE_METADATATool to get document metadata including title, source URL, word count, and custom metadata fields. Use this to display document information or manage your knowledge base.

Input Parameters

string
required
The unique identifier of the page.
integer
required
The unique identifier of the agent (formerly known as project).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_PLUGINSRetrieves plugin details for a specific CustomGPT agent, including configuration, status, and metadata. HTTP errors may be returned in the response rather than raised.

Input Parameters

integer
required
The unique agent id to retrieve plugin details for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_PROJECTGet details for a specific CustomGPT agent, including its status and metadata such as ownership, sharing, sitemap, and embed information.

Input Parameters

string
The width of the embed code. Defaults to 100%.
string
The height of the embed code. Defaults to auto.
integer
required
The unique agent identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_PROJECT_LICENSERetrieve a license for a specific CustomGPT project by license ID. HTTP error responses may be returned as response data rather than raised as errors.

Input Parameters

string
required
Unique identifier of the license to retrieve.
string
required
Unique identifier of the project to which the license belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_PROJECT_SETTINGSRetrieves configuration settings for a CustomGPT agent, including avatar, background, prompt, language, and branding preferences. Error details may be returned in the response for unsuccessful requests.

Input Parameters

string
required
The unique ID of the agent/project whose settings to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_REPORT_ANALYSISTool to retrieve analytics chart data for a CustomGPT project. Returns time-series data formatted for charts, with daily or weekly breakdowns of key metrics including conversation counts, query counts, and queries-per-conversation ratios. Use this to generate usage reports, track project engagement over time, or visualize chatbot performance trends.

Input Parameters

array
required
List of metrics to include in the response. Choose from: conversations (total conversation count), queries (total query count), or queries_per_conversation (average queries per conversation). You can request one or multiple metrics.
string ("daily" | "weekly")
Interval for aggregating analytics data.
integer
required
The ID of the agent/project to get analytics for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_REPORT_CONVERSATIONSTool to get conversation analytics for a CustomGPT project. Returns conversation metrics including total conversations, average queries per conversation, and other engagement statistics. Use this to understand how users engage with your agent and analyze conversation patterns over time.

Input Parameters

string
Filters to return conversation metrics for. Accepts a JSON array format (as a string). An empty array ’[]’ is valid and returns all conversation metrics.
integer
required
The ID of the agent to get conversations analytics for. Obtain this from the List Projects action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_REPORT_INTELLIGENCETool to get customer intelligence for a CustomGPT project. Returns AI-analyzed insights about users including common intents, emotional sentiment, frequently discussed topics, and emerging trends. Use this to understand what users are asking about and identify patterns in user behavior.

Input Parameters

integer
Page number for pagination (≥1). Defaults to 1 if not specified.
array
Filter results by Lead Captured status (1 for captured, 0 for not captured). Multiple values allowed.
integer
Number of items per page (1-1000). Defaults to 100 if not specified.
array
Filter results by User Location (country codes or names). Multiple values allowed.
array
Filter results by Query Sent By (user IDs). Multiple values allowed.
string
Filter results by Verified Claims Score as range (format: min-max, e.g., ‘0-100’).
string
End date for filtering data (ISO 8601 format recommended).
array
Filter results by Query Language. Multiple values allowed.
integer
required
The ID of the project to get customer intelligence for.
string
Start date for filtering data (ISO 8601 format recommended).
array
Filter results by CRM ID. Multiple values allowed.
array
Filter results by User Intent (e.g., ‘informational’, ‘transactional’). Multiple values allowed.
array
Filter results by User Emotion (e.g., ‘positive’, ‘negative’, ‘neutral’). Multiple values allowed.
array
Filter results by Risk: Fidelity (e.g., ‘unavailable’, ‘low’, ‘high’). Multiple values allowed.
array
Filter results by Content Source (e.g., ‘in-context’). Multiple values allowed.
array
Filter results by Deployment source. Multiple values allowed.
array
Filter results by Risk: Jailbreak (e.g., ‘unavailable’, ‘low’, ‘high’). Multiple values allowed.
array
Filter results by Risk: Profanity (e.g., ‘unavailable’, ‘low’, ‘high’). Multiple values allowed.
array
Filter results by Stakeholder Status (e.g., ‘APPROVED’). Multiple values allowed.
array
Filter results by Risk: Prompt Leakage (e.g., ‘unavailable’, ‘low’, ‘high’). Multiple values allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_REPORT_TRAFFICTool to retrieve traffic analytics for a CustomGPT agent/project. Returns user traffic metrics including unique visitors, session counts, geographic distribution, and device types. Use this to understand who’s using your agent and how they’re accessing it.

Input Parameters

array
Filters to apply when retrieving traffic metrics. Pass an empty array to get all traffic data without filters.
integer
required
The ID of the agent/project to get traffic analytics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_STATSGet usage and document statistics for a CustomGPT agent, including query counts, credits used, and pages found, crawled, and indexed.

Input Parameters

integer
required
The unique identifier of the agent (formerly known as project).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_USAGE_LIMITSGet account usage and limits for projects, storage credits, and API queries. Missing usage or limit fields are returned as zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_GET_USER_PROFILETool to retrieve the current user’s profile information. Use when you need to display or verify authenticated user details after login.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_LIST_CONVERSATION_MESSAGESRetrieve messages from a CustomGPT conversation, including user queries and AI responses. Returns an empty list for HTTP 204 or 404; paginated responses yield the returned page of messages.

Input Parameters

string
required
The unique numeric identifier of the CustomGPT project (agent). Obtain this from the List Projects action.
string
required
The unique session identifier (UUID format) of the conversation. Obtained when creating a new conversation or listing conversations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_LIST_PAGESLists documents in a CustomGPT agent’s knowledge base, including webpages and uploaded files. Returns page records and supports filtering by crawl or index status and pagination.

Input Parameters

integer
Page number to return. Defaults to 1 if not specified.
integer
Number of documents to return per page. Defaults to 20 if not specified.
string ("asc" | "desc")
Order direction for sorting pages by ID.
integer
required
The unique agent identifier. Obtain this from the List Projects action.
string ("all" | "ok" | "failed" | "n/a" | "queued" | "limited")
Status values for crawl and index operations.
string ("all" | "ok" | "failed" | "n/a" | "queued" | "limited")
Status values for crawl and index operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_LIST_PERSONASTool to list persona versions for a CustomGPT agent. Use when you need to view 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 time or restore a previous version. Results are paginated. Requires Custom plan.

Input Parameters

integer
Page number to return (≥1). If not specified, returns the first page.
integer
Limit the number of persona versions to return per page. Defaults to 20.
integer
required
The unique agent identifier. Obtain this from the List Projects action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_LIST_PROJECT_LICENSESList licenses for a CustomGPT project or agent using its numeric project ID. Use this to check the project’s license records and their details, such as type, status, and timestamps.

Input Parameters

string
required
The unique identifier of the CustomGPT project (agent). Must be a numeric ID (e.g., ‘90631’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_LIST_PROJECTSLists all CustomGPT projects (agents) for the authenticated user. Returns projects with full details including ID, name, type, chat status, and timestamps. Supports pagination via the ‘page’ parameter. Use this to discover available projects or iterate through all projects.

Input Parameters

integer
Page number for pagination (≥1). If not specified, returns the first page. Results are sorted by creation date (newest first).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_LIST_SOURCESTool to list all data sources connected to an agent. Returns sources from various origins like sitemaps, Google Drive folders, SharePoint sites, or uploaded files. Use this to manage what content feeds into an agent’s knowledge base.

Input Parameters

integer
required
The unique identifier of the agent (formerly known as project).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_REINDEX_PAGEStarts reindexing a URL-based document in a CustomGPT knowledge base to update its content. The response indicates whether the update process started.

Input Parameters

integer
required
The page id of the document to reindex.
integer
required
The unique identifier of the agent (formerly known as project).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_SEARCH_TEAM_MEMBERSTool to search for team members by email address or user ID. Use this to find users when assigning permissions or managing team access. Requires Owner or Admin role to execute.

Input Parameters

string
Email address of the team member to search for. Use this to find users by their email.
integer
User ID of the team member to search for. Use this to find users by their numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_SUBMIT_MESSAGE_FEEDBACKTool to submit feedback (thumbs up/down) for a message in a CustomGPT conversation. Use this to record user satisfaction signals that help identify which AI responses are helpful and which need improvement. Feedback can be changed by submitting a new reaction value.

Input Parameters

integer
required
The unique identifier of the message to submit feedback for. Obtained from listing conversation messages.
string ("neutral" | "disliked" | "liked")
required
The feedback reaction to record for this message. Use ‘liked’ for positive feedback, ‘disliked’ for negative feedback, or ‘neutral’ to clear existing feedback.
integer
required
The ID of the agent (project) containing the message.
string
required
The session ID (UUID format) of the conversation containing the message. Obtained when creating or listing conversations.
array
Optional list of fields to expand in the response for additional insights.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_UPDATE_PAGE_METADATAUpdates metadata for a specific page in a CustomGPT project, including its title, description, URL, and image.

Input Parameters

string
The url of the document used in citations. Maximum 2000 characters.
string
The url of the image used in citations. Maximum 2000 characters.
string
The title of the document used in citations. Maximum 255 characters.
integer
required
The id of a page in which metadata will be updated.
integer
required
The id of an agent (formerly known as project) in which page is stored. Obtain this from the List Projects action.
string
The description of the document used in citations. Maximum 500 characters. Should be one to two sentences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_UPDATE_PROJECTUpdates an existing CustomGPT agent’s name or project configuration, including sharing, sitemap, license, and document-processing settings. Returns updated project details.

Input Parameters

boolean
Whether the agent is public or not. Set to true to make the agent publicly accessible.
integer
required
The unique identifier of the agent (formerly known as project) to update.
string
Agent name to update. Use this to rename the agent.
string
Sitemap path for the agent. Provide a URL to a sitemap XML file.
boolean
Whether the agent should anonymize user data. Set to true to enable data anonymization.
boolean
Whether OCR (Optical Character Recognition) is enabled for document processing.
boolean
Whether to retain file data after processing. Set to true to keep uploaded files.
boolean
Whether project licenses are allowed. Set to true to enable license management for this agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_UPDATE_PROJECT_LICENSEUpdates the name of an existing license for a CustomGPT project/agent. Prerequisites: - The project must have licenses enabled in its plan - Both project ID and license ID must be valid and exist - Use List Projects to get valid project IDs - Use List Project Licenses to get valid license IDs for a project This action only updates the license name. Other license properties cannot be modified through this endpoint.

Input Parameters

string
required
The new name to assign to the license (1-255 characters recommended)
string
required
Unique identifier of the license to update. Obtain this from the List Project Licenses action.
string
required
Numeric ID of the CustomGPT project/agent (as string). Obtain this from the List Projects action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_UPDATE_PROJECT_SETTINGSUpdate CustomGPT agent configuration settings. Updates persona instructions, response format, citation style, branding, and deployment settings. Only include fields you want to change - omitted fields retain their current values. Use this to configure agent behavior, customize appearance, or adjust user experience settings.

Input Parameters

integer
required
The unique identifier of the agent/project whose settings to update
object
Background image file for the agent widget.
string ("inter" | "public-sans")
Font family options for the agent.
object
User avatar image file.
string
Primary color for the agent in hex format (e.g., ‘#000000’)
string ("gpt-4-1" | "gpt-4-o" | "gpt-5-chat" | "gpt-5.1-none" | "gpt-5.1-low" | "gpt-5.2-none" | "gpt-5.2-low" | "gpt-4-1-mini" | "gpt-4o-mini" | "claude-4.5-opus" | "claude-4.5-sonnet" | "claude-4-sonnet" | "claude-4.5-haiku" | "claude-3.5-sonnet" | "gpt-o4-mini-low" | "gpt-o4-mini-medium" | "gpt-o4-mini-high" | "gemini-3-pro" | "gemini-2.5-flash")
AI models available for the agent.
string
Title displayed for the agent
string
Text for ‘view less’ button in starter questions
string
Text for ‘view more’ button in starter questions
string
Default prompt or welcome message shown to users
string
Text appended to every agent response
string ("sharp" | "soft" | "round" | "legacy")
Radius styling options for the agent.
boolean
Whether agent is aware of logged-in user’s name
object
Avatar image file for the agent.
boolean
Whether to remove CustomGPT branding from the agent
string ("default" | "own_content" | "openai_content")
Response source configuration options.
string ("fastest-responses" | "optimal-choice" | "advanced-reasoning" | "complex-tasks")
Agent capability levels for processing user queries.
string ("image" | "color")
Background type for the agent widget.
string ("sq" | "ar" | "hy" | "az" | "ba" | "eu" | "be" | "bn" | "bh" | "bs" | "pt-BR" | "bg" | "yue" | "ca" | "hne" | "hr" | "cs" | "da" | "doi" | "nl" | "en" | "et" | "fo" | "fi" | "fr" | "gl" | "ka" | "de" | "el" | "gu" | "hry" | "he" | "hi" | "hu" | "id" | "ga" | "it" | "ja" | "jv" | "kn" | "ks" | "kk" | "kok" | "ko" | "ky" | "lv" | "lt" | "mk" | "mai" | "ms" | "mt" | "cmn" | "mr" | "mwr" | "nan" | "mo" | "mn" | "me" | "ne" | "no" | "or" | "ps" | "fa" | "pl" | "pt" | "pa" | "raj" | "ro" | "ru" | "sa" | "sat" | "sr" | "sd" | "si" | "sk" | "sl" | "es" | "sw" | "sv" | "tg" | "ta" | "tt" | "te" | "th" | "tr" | "tk" | "uk" | "ur" | "uz" | "vi" | "cy" | "wuu")
Language codes for agent interface messages.
integer
Citation display setting (0-3 scale)
boolean
Whether to show thumbs up/down feedback buttons
Whether to enable enhanced search for numeric codes (may slow responses)
boolean
Whether to enable Markdown formatting in responses
object
Spotlight avatar image file.
string
Background color in hex format (e.g., ‘#FFFFFF’)
array
List of example questions to guide users
string
Message shown while agent is processing a response
string
Message shown when agent cannot answer a question
string
Message shown when the agent encounters an error
boolean
Whether agent monetization is enabled
string
Color for the agent title in hex format
string ("user" | "show" | "hide")
Citation display control options.
boolean
Whether to enable user avatar display
string
Additional text for input field (e.g., Terms of Service URL)
string
System instructions defining agent personality and behavior
boolean
Whether to show avatar next to title
string ("fresh" | "legacy")
Color scheme options for the agent.
string
Color for the agent toolbar in hex format
string ("default" | "image")
Spotlight avatar type options.
boolean
Whether users can share conversations
string ("default" | "first_only")
Image citation display options.
string ("circle" | "rectangle")
Spotlight avatar shape options.
boolean
Whether users can export conversations
string ("agent-left-user-right" | "agent-right-user-right" | "agent-right-user-left" | "agent-left-user-left")
Avatar orientation options.
integer
Conversation activity window: 0=24hr memory limit, 1=unlimited, 2=close after 24hrs
boolean
Whether to enable spotlight avatar display
string
Message encouraging users to ask example questions
string
Label text for the sources section
integer
Custom retention period in days for conversations (used when retention_period is ‘custom’)
boolean
Whether citations appear inline within responses
boolean
Whether to hide source names in agent responses
boolean
Whether to limit the height of image citations
string ("left" | "center" | "right")
Agent title and avatar alignment options.
boolean
Whether to show loading animation while waiting for response
boolean
Whether to use OpenGraph images from source pages in citations
string
Message shown when content fails moderation checks
string ("custom" | "year" | "never")
Conversation retention period options.
string
Label text for the answer source indicator
boolean
Whether to generate context-aware starter questions
boolean
Whether to use reCAPTCHA for public agent access
boolean
Whether agent is aware of its knowledge base scope

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_UPDATE_SOURCEUpdate settings for a CustomGPT agent data source, including auto-sync frequency, refresh behavior, JavaScript execution, image extraction, page creation and removal, and custom refresh schedules.

Input Parameters

integer
required
The unique identifier of the data source to update.
integer
required
The unique identifier of the agent (formerly known as project).
boolean
Whether the agent source should execute JavaScript when crawling web pages.
boolean
Add new pages to agent automatically during refresh agent source.
object
Custom schedule configuration for advanced data refresh frequency.
boolean
Allow extra timeout for agent source during crawling operations.
boolean
Remove pages from agent automatically during refresh agent source if they no longer exist.
string ("none" | "sync_from_sitemap")
Method used for extracting images from the website.
string ("never" | "daily" | "weekly" | "monthly" | "advanced")
Data refresh frequency options for source auto-sync.
string ("never" | "always" | "if_updated")
Options for refreshing existing pages during source sync.
boolean
Whether to update existing images during refresh operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_UPDATE_USER_PROFILEUpdates the authenticated user’s profile information in CustomGPT. Use this action to modify profile details such as the user’s display name, email address, or profile photo URL. All fields are optional - only the fields you provide will be updated. The action returns the complete updated user profile.

Input Parameters

string
The user’s full display name. Can include special characters and Unicode.
string
The user’s email address for account identification and notifications.
string
URL pointing to the user’s profile photo. Note: CustomGPT may auto-generate profile photos based on initials instead of using custom URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CUSTOMGPT_VERIFY_MESSAGETrigger verification of a message in a CustomGPT conversation. The response can include a confirmation message and status.

Input Parameters

integer
required
The message ID of the message to verify.
integer
required
The ID of the agent (project) to verify the message for.
string
required
The session ID of the conversation containing the message to verify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not