# Customgpt

CustomGPT.ai is a platform that enables users to create and integrate AI-powered chatbots tailored to their specific data and requirements.

- **Category:** ai chatbots
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 40
- **Triggers:** 0
- **Slug:** `CUSTOMGPT`
- **Version:** 20260307_00

## Tools

### Activate Persona Version

**Slug:** `CUSTOMGPT_ACTIVATE_PERSONA_VERSION`

Restore 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | integer | Yes | The version number of the persona to activate. This must be a valid version from the persona history. |
| `projectId` | integer | Yes | The unique identifier of the agent (formerly known as project). Obtain this from the List Projects action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Source to Project

**Slug:** `CUSTOMGPT_ADD_SOURCE`

Add a data source to a CustomGPT agent's knowledge base. Connects content via sitemap URL, file upload, or integration. The system begins indexing immediately after creation. Use when adding documentation, FAQs, or knowledge content to an agent.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone CustomGPT Project

**Slug:** `CUSTOMGPT_CLONE_PROJECT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | integer | Yes | The unique agent identifier of the project to clone |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Conversation

**Slug:** `CUSTOMGPT_CREATE_CONVERSATION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional name to identify the conversation. Helps organize and reference conversations later. If not provided, a default name will be assigned. |
| `projectId` | integer | Yes | The unique identifier of the agent (formerly known as project). Obtain this from the List Projects action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create CustomGPT Project

**Slug:** `CUSTOMGPT_CREATE_PROJECT`

Tool to create a new CustomGPT agent from a sitemap URL or file upload. The agent immediately begins processing the content to build its knowledge base. Use when you need to create a new AI agent with custom knowledge from web content or documents. Either sitemap_path or file must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | File to upload for the agent's knowledge base. Either file or sitemap_path must be provided, not both. |
| `project_name` | string | Yes | Name for the new agent. This will be the display name of the agent. |
| `sitemap_path` | string | No | 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. |
| `is_anonymized` | boolean | No | Whether to anonymize data in the agent's knowledge base. Use this to protect sensitive information. |
| `is_ocr_enabled` | boolean | No | Whether to enable OCR (Optical Character Recognition) for extracting text from images and scanned documents. |
| `is_vision_enabled` | boolean | No | Whether to enable vision processing for images in the file source. Allows the agent to process and understand images. |
| `file_data_retension` | boolean | No | Whether to retain file data after processing. If false, only extracted text is kept. |
| `is_vision_compress_image` | boolean | No | Whether to compress images for vision processing. Reduces storage and processing costs for image-heavy content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Page from Agent

**Slug:** `CUSTOMGPT_DELETE_PAGE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pageId` | integer | Yes | The page id |
| `projectId` | integer | Yes | The unique identifier of the agent (formerly known as project). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CustomGPT Project

**Slug:** `CUSTOMGPT_DELETE_PROJECT`

Tool to delete a CustomGPT project by ID. Use when you need to permanently remove an existing agent after confirming the ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | string | Yes | Unique ID of the agent (project) to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CustomGPT Project License

**Slug:** `CUSTOMGPT_DELETE_PROJECT_LICENSE`

Deletes a license from a CustomGPT project/agent. Requires numeric project ID and license ID. This action is idempotent - it succeeds even if the license doesn't exist (404). The project must have licenses enabled in its plan for this endpoint to work properly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `licenseId` | string | Yes | Unique identifier of the license to delete from the project |
| `projectId` | string | Yes | Numeric ID of the CustomGPT agent/project (as string, e.g., '90631'). The API requires integer-formatted project IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete CustomGPT Source

**Slug:** `CUSTOMGPT_DELETE_SOURCE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sourceId` | integer | Yes | The unique identifier of a source to delete. |
| `projectId` | integer | Yes | The unique identifier of the agent (formerly known as project). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Leads

**Slug:** `CUSTOMGPT_EXPORT_LEADS`

Export 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (≥1). If not specified, returns the first page. |
| `limit` | integer | No | Number of items per page (1-500). Defaults to 100 if not specified. |
| `end_date` | string | No | End date for filtering leads (ISO 8601 format, e.g., '2024-12-31T23:59:59Z'). Only leads up to this date will be included. |
| `projectId` | integer | Yes | The unique ID of the project to export leads from. |
| `start_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Message

**Slug:** `CUSTOMGPT_GET_MESSAGE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `promptId` | integer | Yes | The message id of the message |
| `projectId` | integer | Yes | The ID of the agent to get the message for |
| `sessionId` | string | Yes | The session ID of the conversation to get the message from |
| `includeInsights` | array | No | Fields to expand in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Message Trust Score

**Slug:** `CUSTOMGPT_GET_MESSAGE_TRUST_SCORE`

Tool to retrieve verification trust score for a message in a CustomGPT conversation. Returns a score calculated by checking how well the agent's claims are supported by source documents. Higher scores indicate better-grounded responses with stronger evidence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `promptId` | integer | Yes | The message ID of the message to get the trust score for. |
| `projectId` | integer | Yes | The ID of the agent to get the message trust score for. |
| `sessionId` | string | Yes | The session ID of the conversation containing the message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Page Metadata

**Slug:** `CUSTOMGPT_GET_PAGE_METADATA`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pageId` | string | Yes | The unique identifier of the page. |
| `projectId` | integer | Yes | The unique identifier of the agent (formerly known as project). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Agent Plugins

**Slug:** `CUSTOMGPT_GET_PLUGINS`

Tool to retrieve plugin details for a specific CustomGPT agent (project). Use when you need to inspect plugin configuration, status, and metadata for an agent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | integer | Yes | The unique agent id to retrieve plugin details for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get CustomGPT Project

**Slug:** `CUSTOMGPT_GET_PROJECT`

Tool to get agent details. Returns the full configuration and current status for a specific agent. Use this to check processing status, view settings, or retrieve metadata about the agent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `width` | string | No | The width of the embed code. Defaults to 100%. |
| `height` | string | No | The height of the embed code. Defaults to auto. |
| `projectId` | integer | Yes | The unique agent identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project License

**Slug:** `CUSTOMGPT_GET_PROJECT_LICENSE`

Tool to retrieve a license for a specific project. Use when you need to fetch license details by license ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `licenseId` | string | Yes | Unique identifier of the license to retrieve. |
| `projectId` | string | Yes | Unique identifier of the project to which the license belongs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Settings

**Slug:** `CUSTOMGPT_GET_PROJECT_SETTINGS`

Retrieve configuration settings for a specific CustomGPT agent/project. Returns settings including: chatbot avatar, background, default prompt, example questions, response source, language, and branding preferences. Use this to inspect agent configuration, audit settings, or retrieve values before making updates. Note: Some newly created projects may not have settings initialized yet and will return a 404.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | string | Yes | The unique ID of the agent/project whose settings to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Analytics Chart Data

**Slug:** `CUSTOMGPT_GET_REPORT_ANALYSIS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | Yes | 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. |
| `interval` | string ("daily" | "weekly") | No | Interval for aggregating analytics data. |
| `project_id` | integer | Yes | The ID of the agent/project to get analytics for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Conversation Analytics

**Slug:** `CUSTOMGPT_GET_REPORT_CONVERSATIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | string | No | Filters to return conversation metrics for. Accepts a JSON array format (as a string). An empty array '[]' is valid and returns all conversation metrics. |
| `project_id` | integer | Yes | The ID of the agent to get conversations analytics for. Obtain this from the List Projects action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Intelligence Report

**Slug:** `CUSTOMGPT_GET_REPORT_INTELLIGENCE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (≥1). Defaults to 1 if not specified. |
| `leads` | array | No | Filter results by Lead Captured status (1 for captured, 0 for not captured). Multiple values allowed. |
| `limit` | integer | No | Number of items per page (1-1000). Defaults to 100 if not specified. |
| `country` | array | No | Filter results by User Location (country codes or names). Multiple values allowed. |
| `user_id` | array | No | Filter results by Query Sent By (user IDs). Multiple values allowed. |
| `accuracy` | string | No | Filter results by Verified Claims Score as range (format: min-max, e.g., '0-100'). |
| `end_date` | string | No | End date for filtering data (ISO 8601 format recommended). |
| `language` | array | No | Filter results by Query Language. Multiple values allowed. |
| `projectId` | integer | Yes | The ID of the project to get customer intelligence for. |
| `start_date` | string | No | Start date for filtering data (ISO 8601 format recommended). |
| `external_id` | array | No | Filter results by CRM ID. Multiple values allowed. |
| `user_intent` | array | No | Filter results by User Intent (e.g., 'informational', 'transactional'). Multiple values allowed. |
| `user_emotion` | array | No | Filter results by User Emotion (e.g., 'positive', 'negative', 'neutral'). Multiple values allowed. |
| `risk_fidelity` | array | No | Filter results by Risk: Fidelity (e.g., 'unavailable', 'low', 'high'). Multiple values allowed. |
| `content_source` | array | No | Filter results by Content Source (e.g., 'in-context'). Multiple values allowed. |
| `request_source` | array | No | Filter results by Deployment source. Multiple values allowed. |
| `risk_jailbreak` | array | No | Filter results by Risk: Jailbreak (e.g., 'unavailable', 'low', 'high'). Multiple values allowed. |
| `risk_profanity` | array | No | Filter results by Risk: Profanity (e.g., 'unavailable', 'low', 'high'). Multiple values allowed. |
| `stakeholder_status` | array | No | Filter results by Stakeholder Status (e.g., 'APPROVED'). Multiple values allowed. |
| `risk_prompt_leakage` | array | No | Filter results by Risk: Prompt Leakage (e.g., 'unavailable', 'low', 'high'). Multiple values allowed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Traffic Analytics Report

**Slug:** `CUSTOMGPT_GET_REPORT_TRAFFIC`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | No | Filters to apply when retrieving traffic metrics. Pass an empty array to get all traffic data without filters. |
| `project_id` | integer | Yes | The ID of the agent/project to get traffic analytics for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Agent Statistics

**Slug:** `CUSTOMGPT_GET_STATS`

Tool to get agent statistics. Returns usage metrics and performance statistics for an agent, including total conversations, query counts, document statistics, and processing information. Use when you need to monitor agent performance or generate usage reports.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | The unique identifier of the agent (formerly known as project). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage Limits

**Slug:** `CUSTOMGPT_GET_USAGE_LIMITS`

Get account usage limits showing current usage vs. maximum allowed for projects, storage credits, and API queries. This returns how many projects, storage credits (characters indexed), and queries you've used compared to your account's maximum limits. Use this to monitor quota consumption.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User Profile

**Slug:** `CUSTOMGPT_GET_USER_PROFILE`

Tool to retrieve the current user's profile information. Use when you need to display or verify authenticated user details after login.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversation Messages

**Slug:** `CUSTOMGPT_LIST_CONVERSATION_MESSAGES`

Retrieves all messages from a CustomGPT conversation, including both user queries and AI responses. Use this to view the complete chat history for a specific conversation session. Returns an empty list if the conversation doesn't exist or has no messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | string | Yes | The unique numeric identifier of the CustomGPT project (agent). Obtain this from the List Projects action. |
| `sessionId` | string | Yes | The unique session identifier (UUID format) of the conversation. Obtained when creating a new conversation or listing conversations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Agent Documents

**Slug:** `CUSTOMGPT_LIST_PAGES`

Lists all documents in a CustomGPT agent's knowledge base. Returns indexed content including webpages, PDFs, and uploaded files that the agent can reference. Supports filtering by crawl/index status and pagination. Use this to audit knowledge sources or verify successful document ingestion.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Persona Versions

**Slug:** `CUSTOMGPT_LIST_PERSONAS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to return (≥1). If not specified, returns the first page. |
| `limit` | integer | No | Limit the number of persona versions to return per page. Defaults to 20. |
| `project_id` | integer | Yes | The unique agent identifier. Obtain this from the List Projects action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List CustomGPT Project Licenses

**Slug:** `CUSTOMGPT_LIST_PROJECT_LICENSES`

List all licenses for a CustomGPT project/agent. Returns an array of license objects with details like ID, type, status, and timestamps. Returns an empty array if the project has no licenses or if licenses are not enabled for the project. Use this when you need to check what licenses exist for a specific project/agent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | string | Yes | The unique identifier of the CustomGPT project (agent). Must be a numeric ID (e.g., '90631'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List CustomGPT Projects

**Slug:** `CUSTOMGPT_LIST_PROJECTS`

Lists 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (≥1). If not specified, returns the first page. Results are sorted by creation date (newest first). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Agent Sources

**Slug:** `CUSTOMGPT_LIST_SOURCES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | The unique identifier of the agent (formerly known as project). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reindex Page

**Slug:** `CUSTOMGPT_REINDEX_PAGE`

Tool to reindex a document in CustomGPT knowledge base. Re-crawls and re-indexes a URL-based document to update its content. Use this when the source content has changed and you want the agent to use the updated version. Only works for URL-based documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pageId` | integer | Yes | The page id of the document to reindex. |
| `projectId` | integer | Yes | The unique identifier of the agent (formerly known as project). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Team Members

**Slug:** `CUSTOMGPT_SEARCH_TEAM_MEMBERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Email address of the team member to search for. Use this to find users by their email. |
| `user_id` | integer | No | User ID of the team member to search for. Use this to find users by their numeric ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Message Feedback

**Slug:** `CUSTOMGPT_SUBMIT_MESSAGE_FEEDBACK`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `promptId` | integer | Yes | The unique identifier of the message to submit feedback for. Obtained from listing conversation messages. |
| `reaction` | string ("neutral" | "disliked" | "liked") | Yes | The feedback reaction to record for this message. Use 'liked' for positive feedback, 'disliked' for negative feedback, or 'neutral' to clear existing feedback. |
| `projectId` | integer | Yes | The ID of the agent (project) containing the message. |
| `sessionId` | string | Yes | The session ID (UUID format) of the conversation containing the message. Obtained when creating or listing conversations. |
| `includeInsights` | array | No | Optional list of fields to expand in the response for additional insights. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Page Metadata

**Slug:** `CUSTOMGPT_UPDATE_PAGE_METADATA`

Update document metadata for a specific page in a CustomGPT project. Updates custom metadata fields such as title, description, URL, and image that help organize and manage your knowledge base. Use when you need to add tags, categories, or other organizational information to documents.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `CUSTOMGPT_UPDATE_PROJECT`

Updates an existing CustomGPT agent's name or configuration settings. Use this to rename an agent or modify its basic properties without affecting its knowledge base. Returns the complete updated project details including all metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `is_shared` | boolean | No | Whether the agent is public or not. Set to true to make the agent publicly accessible. |
| `project_id` | integer | Yes | The unique identifier of the agent (formerly known as project) to update. |
| `project_name` | string | No | Agent name to update. Use this to rename the agent. |
| `sitemap_path` | string | No | Sitemap path for the agent. Provide a URL to a sitemap XML file. |
| `is_anonymized` | boolean | No | Whether the agent should anonymize user data. Set to true to enable data anonymization. |
| `is_ocr_enabled` | boolean | No | Whether OCR (Optical Character Recognition) is enabled for document processing. |
| `file_data_retension` | boolean | No | Whether to retain file data after processing. Set to true to keep uploaded files. |
| `are_licenses_allowed` | boolean | No | Whether project licenses are allowed. Set to true to enable license management for this agent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project License

**Slug:** `CUSTOMGPT_UPDATE_PROJECT_LICENSE`

Updates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The new name to assign to the license (1-255 characters recommended) |
| `licenseId` | string | Yes | Unique identifier of the license to update. Obtain this from the List Project Licenses action. |
| `projectId` | string | Yes | Numeric ID of the CustomGPT project/agent (as string). Obtain this from the List Projects action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project Settings

**Slug:** `CUSTOMGPT_UPDATE_PROJECT_SETTINGS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | integer | Yes | The unique identifier of the agent/project whose settings to update |
| `chat_bot_bg` | object | No | Background image file for the agent widget. |
| `font_family` | string ("inter" | "public-sans") | No | Font family options for the agent. |
| `user_avatar` | object | No | User avatar image file. |
| `chatbot_color` | string | No | Primary color for the agent in hex format (e.g., '#000000') |
| `chatbot_model` | 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") | No | AI models available for the agent. |
| `chatbot_title` | string | No | Title displayed for the agent |
| `view_less_msg` | string | No | Text for 'view less' button in starter questions |
| `view_more_msg` | string | No | Text for 'view more' button in starter questions |
| `default_prompt` | string | No | Default prompt or welcome message shown to users |
| `ending_message` | string | No | Text appended to every agent response |
| `radius_styling` | string ("sharp" | "soft" | "round" | "legacy") | No | Radius styling options for the agent. |
| `user_awareness` | boolean | No | Whether agent is aware of logged-in user's name |
| `chat_bot_avatar` | object | No | Avatar image file for the agent. |
| `remove_branding` | boolean | No | Whether to remove CustomGPT branding from the agent |
| `response_source` | string ("default" | "own_content" | "openai_content") | No | Response source configuration options. |
| `agent_capability` | string ("fastest-responses" | "optimal-choice" | "advanced-reasoning" | "complex-tasks") | No | Agent capability levels for processing user queries. |
| `chat_bot_bg_type` | string ("image" | "color") | No | Background type for the agent widget. |
| `chatbot_msg_lang` | 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") | No | Language codes for agent interface messages. |
| `enable_citations` | integer | No | Citation display setting (0-3 scale) |
| `enable_feedbacks` | boolean | No | Whether to show thumbs up/down feedback buttons |
| `is_hybrid_search` | boolean | No | Whether to enable enhanced search for numeric codes (may slow responses) |
| `markdown_enabled` | boolean | No | Whether to enable Markdown formatting in responses |
| `spotlight_avatar` | object | No | Spotlight avatar image file. |
| `chat_bot_bg_color` | string | No | Background color in hex format (e.g., '#FFFFFF') |
| `example_questions` | array | No | List of example questions to guide users |
| `hang_in_there_msg` | string | No | Message shown while agent is processing a response |
| `no_answer_message` | string | No | Message shown when agent cannot answer a question |
| `chatbot_siesta_msg` | string | No | Message shown when the agent encounters an error |
| `is_selling_enabled` | boolean | No | Whether agent monetization is enabled |
| `chatbot_title_color` | string | No | Color for the agent title in hex format |
| `citations_view_type` | string ("user" | "show" | "hide") | No | Citation display control options. |
| `user_avatar_enabled` | boolean | No | Whether to enable user avatar display |
| `input_field_addendum` | string | No | Additional text for input field (e.g., Terms of Service URL) |
| `persona_instructions` | string | No | System instructions defining agent personality and behavior |
| `title_avatar_enabled` | boolean | No | Whether to show avatar next to title |
| `chat_bot_color_scheme` | string ("fresh" | "legacy") | No | Color scheme options for the agent. |
| `chatbot_toolbar_color` | string | No | Color for the agent toolbar in hex format |
| `spotlight_avatar_type` | string ("default" | "image") | No | Spotlight avatar type options. |
| `can_share_conversation` | boolean | No | Whether users can share conversations |
| `image_citation_display` | string ("default" | "first_only") | No | Image citation display options. |
| `spotlight_avatar_shape` | string ("circle" | "rectangle") | No | Spotlight avatar shape options. |
| `can_export_conversation` | boolean | No | Whether users can export conversations |
| `user_avatar_orientation` | string ("agent-left-user-right" | "agent-right-user-right" | "agent-right-user-left" | "agent-left-user-left") | No | Avatar orientation options. |
| `conversation_time_window` | integer | No | Conversation activity window: 0=24hr memory limit, 1=unlimited, 2=close after 24hrs |
| `spotlight_avatar_enabled` | boolean | No | Whether to enable spotlight avatar display |
| `try_asking_questions_msg` | string | No | Message encouraging users to ask example questions |
| `citations_sources_label_msg` | string | No | Label text for the sources section |
| `conversation_retention_days` | integer | No | Custom retention period in days for conversations (used when retention_period is 'custom') |
| `enable_inline_citations_api` | boolean | No | Whether citations appear inline within responses |
| `hide_sources_from_responses` | boolean | No | Whether to hide source names in agent responses |
| `limit_image_citation_height` | boolean | No | Whether to limit the height of image citations |
| `agent_title_avatar_alignment` | string ("left" | "center" | "right") | No | Agent title and avatar alignment options. |
| `is_loading_indicator_enabled` | boolean | No | Whether to show loading animation while waiting for response |
| `use_opengraph_image_citation` | boolean | No | Whether to use OpenGraph images from source pages in citations |
| `chatbot_failed_moderation_msg` | string | No | Message shown when content fails moderation checks |
| `conversation_retention_period` | string ("custom" | "year" | "never") | No | Conversation retention period options. |
| `citations_answer_source_label_msg` | string | No | Label text for the answer source indicator |
| `use_context_aware_starter_question` | boolean | No | Whether to generate context-aware starter questions |
| `enable_recaptcha_for_public_chatbots` | boolean | No | Whether to use reCAPTCHA for public agent access |
| `enable_agent_knowledge_base_awareness` | boolean | No | Whether agent is aware of its knowledge base scope |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Source Settings

**Slug:** `CUSTOMGPT_UPDATE_SOURCE`

Update source settings for a CustomGPT agent data source. Configure how the source is indexed and kept up to date by adjusting auto-sync frequency, crawl depth, file filters, and refresh behavior. Use this to fine-tune sitemap crawling (JavaScript execution, image extraction), control which pages are added or removed during syncs, and set up custom refresh schedules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_id` | integer | Yes | The unique identifier of the data source to update. |
| `project_id` | integer | Yes | The unique identifier of the agent (formerly known as project). |
| `executive_js` | boolean | No | Whether the agent source should execute JavaScript when crawling web pages. |
| `create_new_pages` | boolean | No | Add new pages to agent automatically during refresh agent source. |
| `refresh_schedule` | object | No | Custom schedule configuration for advanced data refresh frequency. |
| `allow_extra_timeout` | boolean | No | Allow extra timeout for agent source during crawling operations. |
| `remove_unexist_pages` | boolean | No | Remove pages from agent automatically during refresh agent source if they no longer exist. |
| `image_extraction_type` | string ("none" | "sync_from_sitemap") | No | Method used for extracting images from the website. |
| `data_refresh_frequency` | string ("never" | "daily" | "weekly" | "monthly" | "advanced") | No | Data refresh frequency options for source auto-sync. |
| `refresh_existing_pages` | string ("never" | "always" | "if_updated") | No | Options for refreshing existing pages during source sync. |
| `update_existing_images` | boolean | No | Whether to update existing images during refresh operations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Profile

**Slug:** `CUSTOMGPT_UPDATE_USER_PROFILE`

Updates 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Message Accuracy

**Slug:** `CUSTOMGPT_VERIFY_MESSAGE`

Tool to verify message accuracy by triggering a fact-checking verification process. Use when you need to verify claims in a conversation message against source documents. The system compares each claim and reports which claims are supported, partially supported, or unsupported.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `promptId` | integer | Yes | The message ID of the message to verify. |
| `projectId` | integer | Yes | The ID of the agent (project) to verify the message for. |
| `sessionId` | string | Yes | The session ID of the conversation containing the message to verify. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |