The CustomGPT AI connector lets your AI agent act in each user's CustomGPT AI account. Each user connects their own CustomGPT AI access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 34 · 19 · 634 read19 write6 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the CustomGPT AI connection
In AgentKit > Connections, create a CustomGPT AI connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'customgpt'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize CustomGPT AI:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'customgpt_agents_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "customgpt"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize CustomGPT AI:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="customgpt_agents_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their CustomGPT AI credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcustomgpt_agent_getGet one agent's configuration and processing status.Read-onlyGet Agent
Get one agent's configuration and processing status. Returns data (id, project_name, sitemap_path, is_chat_active, is_master, user_id, team_id, created_at, updated_at, deleted_at). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent to retrieve. Obtain agent IDs from the response of GET /api/v1/projects or POST /api/v1/projects. Example: 12345
customgpt_agent_settings_getGet an agent's full settings: persona instructions, response behavior, citations, deployment options and feature flags.Read-onlyGet Agent Settings
Get an agent's full settings: persona instructions, response behavior, citations, deployment options and feature flags. Returns data (chatbot_avatar, chatbot_background_type, radius_styling, font_family, chatbot_background, chatbot_background_color, chatbot_color_scheme, default_prompt, example_questions, response_source). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
customgpt_agent_stats_getGet an agent's usage statistics: conversations, queries, documents, words and crawl progress.Read-onlyGet Agent Stats
Get an agent's usage statistics: conversations, queries, documents, words and crawl progress. Returns data (pages_found, pages_crawled, pages_indexed, crawl_credits_used, query_credits_used, total_queries, total_words_indexed, total_storage_credits_used). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
customgpt_agents_listList the agents (projects) in the account, newest first, optionally filtered by name.Read-onlyList Agents
List the agents (projects) in the account, newest first, optionally filtered by name. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Use this to get the agent ID other tools need. Use customgpt_agent_get for one agent's status.
Inputs
namestring- Filter the results by agent name. Example: Support conversation
orderstring- Sort direction for results. One of: asc, desc. Example: descone of
ascdesc order_bystring- Field to sort results by. One of: id, created_at. Example: idone of
idcreated_at pageinteger- Page number to retrieve. Page numbering starts at 1. Increment until the response's last_page value is reached to paginate through all results. Default: 1. Example: 1
customgpt_child_agents_listList the child agents assigned to a Multi-Agent.Read-onlyList Child Agents
List the child agents assigned to a Multi-Agent. Returns data (children, total). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the Multi-Agent project. Example: 12345
customgpt_citation_getGet a citation's source title, description, URL and preview image.Read-onlyGet Citation
Get a citation's source title, description, URL and preview image. Returns data (id, url, title, description, library_map_snapshot, image). Get citation IDs from a message's citations.
Inputs
citation_idintegerrequired- The unique citation identifier. Example: 99001
project_idintegerrequired- The unique project identifier. Example: 12345
customgpt_citation_preview_getGet a preview of the source document behind a citation.Read-onlyGet Citation Preview
Get a preview of the source document behind a citation. Use after customgpt_citation_get.
Inputs
page_idintegerrequired- The unique identifier of the citation source to preview. Obtained from citation objects returned by the messages endpoint. Example: 445566
customgpt_conversation_messages_listList the prompts and agent responses in a conversation, with citations and timestamps.Read-onlyList Conversation Messages
List the prompts and agent responses in a conversation, with citations and timestamps. Returns data (conversation, messages). Get the session ID from customgpt_conversations_list or customgpt_conversation_create.
Inputs
project_idintegerrequired- The ID of the agent to get the messages for. Example: 12345
session_idstringrequired- The session ID of the converstaions to get the messages for. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
include_insightsboolean- When true, includes customer_intelligence data in the response. Example: true
orderstring- Sort direction for messages. One of: asc, desc. Example: descone of
ascdesc pageinteger- Page number to return. Example: 1
customgpt_conversations_listList an agent's conversations, most recent first, optionally by user type, name or last activity.Read-onlyList Conversations
List an agent's conversations, most recent first, optionally by user type, name or last activity. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Use customgpt_conversation_messages_list for one conversation's messages. Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The ID of the agent to get the conversations for. Example: 12345
last_updated_afterstring- Only conversations that received message(s) after this date will be returned in results. If not set, the parameter is ignored. Example: 2026-01-01T00:00:00Z
namestring- Filter the results by conversation name. Example: Support conversation
orderstring- Sort direction for results. One of: asc, desc. Example: descone of
ascdesc order_bystring- Field to sort results by. One of: id, created_at. Example: idone of
idcreated_at pageinteger- Page number to retrieve. Page numbering starts at 1. Increment until the response's last_page value is reached to paginate through all results. Default: 1. Example: 1
user_filterstring- Filter conversations by user type. One of: all, anonymous, team_member, me. Example: allone of
allanonymousteam_memberme
customgpt_deployment_settings_getGet an agent's deployment settings for the embed, live chat, AI assistant, instant viewer and SGE widgets.Read-onlyGet Deployment Settings
Get an agent's deployment settings for the embed, live chat, AI assistant, instant viewer and SGE widgets. Returns data (embed, live_chat, ai_assistant, instant_viewer, sge). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent. Example: 12345
customgpt_document_labels_getGet the tags (labels) assigned to a document for access control.Read-onlyGet Document Tags
Get the tags (labels) assigned to a document for access control. Returns data (a list of records with id, name). Get the page ID from customgpt_documents_list.
Inputs
page_idintegerrequired- The unique identifier of the page/document. Example: 445566
project_idintegerrequired- The unique identifier of the agent. Example: 12345
customgpt_document_metadata_getGet a document's citation metadata: title, URL, description and image.Read-onlyGet Document Metadata
Get a document's citation metadata: title, URL, description and image. Returns data (id, url, title, description, library_map_snapshot, image). Get the page ID from customgpt_documents_list.
Inputs
page_idintegerrequired- The unique page id. Example: 445566
project_idintegerrequired- The unique agent id. Example: 12345
customgpt_documents_listList the documents (web pages and files) in an agent's knowledge base, with crawl and index status.Read-onlyList Documents
List the documents (web pages and files) in an agent's knowledge base, with crawl and index status. Returns data (project, pages). Use this to find a page ID. Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique agent identifier. Example: 12345
crawl_statusstring- Filter pages by crawl status. One of: all, ok, failed, n/a, queued, limited. Example: allone of
allokfailedn/aqueuedlimited index_statusstring- Filter pages by index status. One of: all, ok, failed, n/a, queued, limited. Example: allone of
allokfailedn/aqueuedlimited limitinteger- Limit the number of documents to return. Defaults to 20. Example: 20
orderstring- Sort direction for results. One of: asc, desc. Example: descone of
ascdesc pageinteger- Page number to retrieve. Page numbering starts at 1. Increment until the response's last_page value is reached to paginate through all results. Default: 1. Example: 1
searchstring- Filter documents by a search term. Performs a case-insensitive substring match against the document URL and filename. For example, search=annual-report matches both https://example.com/annual-report-2024.pdf and annual-report-summary.pdf. Supports wildcards: - * matches any sequence of characters (e.g., search=annual*report matches annual-sales-report.pdf and annual-lease-report.pdf) - ? matches a single character (e.g., search=v?-report matches v1-report, v2-report, v3-report) When omitted, all documents are returned. Example: annual-report
customgpt_licenses_listList an agent's access licenses.Read-onlyList Licenses
List an agent's access licenses. Returns data (a list of records with name, key, project_id, created_at, updated_at). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
customgpt_message_claims_getGet the factual claims extracted from a response and their verification against sources.Read-onlyGet Message Claims
Get the factual claims extracted from a response and their verification against sources. Returns data (extracted_claims, evaluation_duration_ms). Run customgpt_message_verify first if no claims exist.
Inputs
project_idintegerrequired- The ID of the agent to get the messages for. Example: 12345
prompt_idintegerrequired- The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint. Example: 678901
session_idstringrequired- The session ID of the conversation to get the messages for. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
customgpt_message_getGet one message with its prompt, response, citations and metadata.Read-onlyGet Message
Get one message with its prompt, response, citations and metadata. Returns data (id, conversation_id, user_id, user_query, openai_response, citations, citations_external, citations_hidden, tools, metadata). Get the prompt ID from customgpt_conversation_messages_list.
Inputs
project_idintegerrequired- The ID of the agent to get the messages for. Example: 12345
prompt_idintegerrequired- The unique identifier of the message to retrieve. Obtain message IDs from GET /api/v1/projects/{projectId}/conversations/{sessionId}/messages. Example: 678901
session_idstringrequired- The session ID of the conversation to get the messages for. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
include_insightsboolean- When true, includes customer_intelligence data in the response. Only has an effect if the lead capture feature is enabled for this agent. Example: true
customgpt_message_trust_score_getGet the trust score computed for a response.Read-onlyGet Message Trust Score
Get the trust score computed for a response. Returns data (overall_status, stakeholder_analysis). Run customgpt_message_verify first.
Inputs
project_idintegerrequired- The ID of the agent to get the messages for. Example: 12345
prompt_idintegerrequired- The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint. Example: 678901
session_idstringrequired- The session ID of the conversation to get the messages for. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
customgpt_persona_versions_listList the saved versions of an agent's persona instructions.Read-onlyList Persona Versions
List the saved versions of an agent's persona instructions. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Use customgpt_persona_version_activate to roll back. Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique agent identifier. Example: 12345
limitinteger- Limit the number of documents to return. Defaults to 20. Example: 20
pageinteger- Page number to return. Example: 1
customgpt_report_analysis_getGet chart-ready time series of queries, conversations and queries per conversation, daily or weekly.Read-onlyGet Analysis Report
Get chart-ready time series of queries, conversations and queries per conversation, daily or weekly. Returns data (queries, conversations, queries_per_conversation). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
filtersarrayrequired- Filters to return graph-ready analysis data for. Example: ["queries"]
project_idintegerrequired- The ID of the agent to get analysis for. Example: 12345
intervalstring- Time interval for aggregating analytics data. One of: daily, weekly. Example: weeklyone of
dailyweekly
customgpt_report_conversations_getGet conversation metrics: total conversations and average queries per conversation.Read-onlyGet Conversations Report
Get conversation metrics: total conversations and average queries per conversation. Returns data (total, average_queries_per_conversation). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
filtersarrayrequired- Filters to return conversations metrics for. Example: ["total"]
project_idintegerrequired- The ID of the agent to get conversations for. Example: 12345
customgpt_report_intelligence_getGet AI-analyzed insights per query: intent, emotion, content source, verified claims score and risks, filterable by those fields.Read-onlyGet Customer Intelligence
Get AI-analyzed insights per query: intent, emotion, content source, verified claims score and risks, filterable by those fields. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The ID of the project to get customer intelligence for. Example: 12345
accuracystring- Filter results by Verified Claims Score as range (format: min-max, e.g., 0-100) Example: 0-100
content_sourcearray- Filter results by Content Source (use repeated parameters, e.g. content_source[]=value) Example: ["in-context"]
end_datestring- End of the date range for the intelligence report. ISO 8601 datetime format (e.g., 2024-03-31T23:59:59Z). Data up to this point is included in the response. Example: 2026-01-31T23:59:59Z
limitinteger- Number of items to return per page. Maximum is 100. Example: 20
pageinteger- Page number to return. Example: 1
request_sourcearray- Filter results by Deployment (use repeated parameters, e.g. request_source[]=value) Example: ["web"]
start_datestring- Start of the date range for the intelligence report. ISO 8601 datetime format (e.g., 2024-01-15T00:00:00Z). Data from this point onward is included in the response. Example: 2026-01-01T00:00:00Z
user_emotionarray- Filter results by User Emotion (use repeated parameters, e.g. user_emotion[]=value) Example: ["positive"]
user_intentarray- Filter results by User Intent (use repeated parameters, e.g. user_intent[]=value) Example: ["informational"]
customgpt_report_leads_getGet leads (emails, names and custom fields) captured from conversations in a date range.Read-onlyGet Leads Report
Get leads (emails, names and custom fields) captured from conversations in a date range. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The ID of the project to get leads export for. Example: 12345
end_datestring- End date for the export range (ISO 8601 format) Example: 2026-01-31T23:59:59Z
limitinteger- Number of lead records to return per page. Maximum is 100. Example: 20
pageinteger- Page number to return. Example: 1
session_idstring- Filter leads to a specific conversation by its session_id. When omitted, leads from all conversations in the project are returned. When the session_id does not match a conversation in this project the response is empty. Example: 12345
start_datestring- Start date for the export range (ISO 8601 format) Example: 2026-01-01T00:00:00Z
customgpt_report_queries_getGet query metrics: total volume and query status breakdown.Read-onlyGet Queries Report
Get query metrics: total volume and query status breakdown. Returns data (total, query_status). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
filtersarrayrequired- Filters to return queries metrics for. Example: ["total"]
project_idintegerrequired- The ID of the agent to get queries for. Example: 12345
customgpt_report_traffic_getGet conversation volume by deployment channel (web widget, API, Slack and others).Read-onlyGet Traffic Report
Get conversation volume by deployment channel (web widget, API, Slack and others). Returns data (sources). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
filtersarrayrequired- Filters to return traffic metrics for. Example: ["sources"]
project_idintegerrequired- The ID of the agent to get traffic for. Example: 12345
customgpt_sources_listList an agent's data sources (sitemaps, uploads and integrations) with their sync settings.Read-onlyList Sources
List an agent's data sources (sitemaps, uploads and integrations) with their sync settings. Returns data (uploads, sitemaps, zapiers, confluences, youtubes, vimeos, podcasts, rsses, linkedins, sharepoints). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
customgpt_tag_getGet one tag with its name and assigned users.Read-onlyGet Tag
Get one tag with its name and assigned users. Returns data (id, name, users). Get the tag ID from customgpt_tags_list.
Inputs
label_idintegerrequired- The unique identifier of the tag to operate on. Example: 321
project_idintegerrequired- The unique identifier of the agent. Example: 12345
customgpt_task_getPoll a Plan & Act task for its status, new events and final answer.Read-onlyGet Task
Poll a Plan & Act task for its status, new events and final answer. Returns data (task, status, events, result). Use after a task is started in CustomGPT.
Inputs
project_idintegerrequired- The unique identifier of the agent. Example: 12345
task_idstringrequired- The task ID. This is the value returned in data.id when you create a task via POST /tasks. Example: task_01HZX5K9ABC
customgpt_tasks_listList an agent's Plan & Act tasks, most recent first.Read-onlyList Tasks
List an agent's Plan & Act tasks, most recent first. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent. Example: 12345
limitinteger- Number of results per page. Example: 20
pageinteger- The page to retrieve. Page numbering starts at 1. To retrieve all tasks, keep incrementing this value until it equals last_page in the response. Default: 1. Example: 1
customgpt_team_invitations_listList pending invitations to the current team.Read-onlyList Team Invitations
List pending invitations to the current team. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Use customgpt_team_invitation_create to invite someone.
Inputs
limitinteger- Limit the number of results to return. Defaults to 20. Example: 20
pageinteger- Page number to retrieve. Page numbering starts at 1. Increment until the response's last_page value is reached to paginate through all results. Default: 1. Example: 1
customgpt_team_members_listList the members of the current team with their roles.Read-onlyList Team Members
List the members of the current team with their roles. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Use this to get user IDs for tag assignment.
Inputs
limitinteger- Limit the number of results to return. Defaults to 20. Example: 20
pageinteger- Page number to retrieve. Page numbering starts at 1. Increment until the response's last_page value is reached to paginate through all results. Default: 1. Example: 1
customgpt_teams_listList the teams the user belongs to.Read-onlyList Teams
List the teams the user belongs to. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Use this to see which team context the key works in.
Inputs
limitinteger- Limit the number of results to return. Defaults to 20. Example: 20
pageinteger- Page number to retrieve. Page numbering starts at 1. Increment until the response's last_page value is reached to paginate through all results. Default: 1. Example: 1
customgpt_usage_limits_getGet the account's current usage and plan limits for agents, words stored and monthly queries.Read-onlyGet Usage Limits
Get the account's current usage and plan limits for agents, words stored and monthly queries. Returns data (max_projects_num, current_projects_num, max_total_storage_credits, current_total_storage_credits, max_queries, current_queries). Use this before large uploads or query batches.
Inputs
This tool takes no inputs.
customgpt_user_getGet the profile of the user who owns the API key.Read-onlyGet Current User
Get the profile of the user who owns the API key. Returns data (created_at, email, id, current_team_id, name, profile_photo_url, updated_at). Use this to confirm the connection.
Inputs
This tool takes no inputs.
customgpt_agent_replicateCreate a full copy of an agent, including its knowledge base, persona and settings.WriteReplicate Agent
Create a full copy of an agent, including its knowledge base, persona and settings. Returns data (id, project_name, sitemap_path, is_chat_active, is_master, user_id, team_id, created_at, updated_at, deleted_at). Use this to make a test variant or template copy. Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique agent identifier. Example: 12345
customgpt_conversation_createStart a new, optionally named conversation session with an agent.WriteCreate Conversation
Start a new, optionally named conversation session with an agent. Returns data (created_at, updated_at, deleted_at, id, name, project_id, created_by, session_id). Returns the session ID to use with customgpt_message_send. Get the agent ID (projectId) from customgpt_agents_list.
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
namestring- Conversation name. Example: Support conversation
customgpt_conversation_updateRename a conversation.WriteUpdate Conversation
Rename a conversation. Returns data (created_at, updated_at, deleted_at, id, name, project_id, created_by, session_id). Get the session ID from customgpt_conversations_list or customgpt_conversation_create.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
session_idstringrequired- The unique session identifier. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
namestring- The new name of the conversation. Example: Support conversation
customgpt_deployment_settings_updateUpdate one deployment section (embed, live_chat, ai_assistant, instant_viewer or sge) of an agent.WriteUpdate Deployment Settings
Update one deployment section (embed, live_chat, ai_assistant, instant_viewer or sge) of an agent. Only the fields sent change. Returns data (embed, live_chat, ai_assistant, instant_viewer, sge). Get the agent ID (projectId) from customgpt_agents_list.
- Idempotent
Inputs
project_idintegerrequired- The unique agent identifier. Example: 12345
sectionstringrequired- Deployment section to update. One of: embed, live_chat, ai_assistant, instant_viewer, sge. Example: live_chatone of
embedlive_chatai_assistantinstant_viewersge auto_pop_upinteger- Live chat auto-popup target. Accepted values: 0 (disabled), 1 (desktop), 2 (mobile), 3 (desktop and mobile). Applies to: live_chat. One of: 0, 1, 2, 3. Example: 0one of
0123 auto_prompt_starter_questionboolean- Automatically prompt the first starter question. Applies to: live_chat. Example: false
auto_start_conversationboolean- Automatically start a new conversation when the widget opens. Applies to: live_chat. Example: true
chatbot_typestring- Visual style of the deployment widget. live_chat accepts window, compact, floating; ai_assistant and instant_viewer accept window, compact. Applies to: live_chat, ai_assistant, instant_viewer. One of: window, compact, floating. Example: compactone of
windowcompactfloating continue_conversationboolean- Persist and continue the previous conversation. Applies to: live_chat. Example: false
custom_search_parameterstring- URL query parameter name to pass as the search query. Alphanumeric, dash, underscore; max 15 characters. Applies to: sge. Example: q
default_button_colorstring- Hex color for the default trigger button. Accepted formats: #FFF, #FFFFFF, or #FFFFFFFF. Applies to: ai_assistant, instant_viewer. Example: #2563EB
default_button_textstring- Label text on the default trigger button. Applies to: ai_assistant, instant_viewer. Example: Ask AI
delay_iframe_load_msnumber- Milliseconds to delay iframe load. Applies to: embed, sge. Example: 0
do_not_prompt_on_mobileboolean- Suppress auto-prompts on mobile devices. Applies to: live_chat. Example: false
heightnumber- Widget height value. Applies to: embed, live_chat, sge. Example: 500
height_typestring- Whether height is fixed or automatic. Applies to: embed, live_chat, sge. One of: fixed, auto. Example: fixedone of
fixedauto height_unitstring- Unit for height. Applies to: embed, live_chat, sge. One of: px, %. Example: pxone of
px% hide_prompt_from_starter_question_listboolean- Hide the pre-prompt from the starter question list. Applies to: live_chat. Example: false
icon_sizestring- Icon size for the live chat bubble trigger. Applies to: live_chat. One of: small, medium, large. Example: smallone of
smallmediumlarge is_crm_integration_enabledboolean- Whether CRM integration is enabled for this deployment. Applies to: embed, live_chat, ai_assistant, instant_viewer, sge. Example: false
is_custom_context_enabledboolean- Whether custom context injection is enabled. Applies to: embed, live_chat, ai_assistant, instant_viewer, sge. Example: false
is_labels_filter_enabledboolean- Filter responses by source labels. Requires a plan with source labeling. Applies to: embed, live_chat, ai_assistant, instant_viewer, sge. Example: false
is_pre_prompt_enabledboolean- Whether the pre-prompt is enabled for this deployment. Applies to: embed, live_chat, ai_assistant, instant_viewer. Example: false
is_using_custom_elementboolean- Whether a custom HTML element is used as the trigger. Applies to: ai_assistant, instant_viewer. Example: false
is_using_default_buttonboolean- Whether to show the default styled button. Applies to: ai_assistant, instant_viewer. Example: true
labels_exclusiveboolean- When label filtering is active, use exclusive AND matching. Applies to: embed, live_chat, ai_assistant, instant_viewer, sge. Example: false
mobile_font_sizeboolean- Use mobile-optimized font sizing. Applies to: embed, live_chat, ai_assistant, instant_viewer, sge. Example: true
positionstring- Screen position of the live chat bubble. Applies to: live_chat. One of: right, left. Example: rightone of
rightleft reset_conversationboolean- Reset the conversation on each new session. Applies to: embed, live_chat, ai_assistant, instant_viewer. Example: false
widthnumber- Widget width value. Applies to: embed, live_chat. Example: 100
width_unitstring- Unit for width. Applies to: embed, live_chat. One of: px, %. Example: %one of
px%
customgpt_document_labels_setReplace the tags (labels) on a document.WriteSet Document Tags
Replace the tags (labels) on a document. An empty list makes it visible to everyone. Returns data (a list of records with id, name). Get tag IDs from customgpt_tags_list.
- Idempotent
Inputs
page_idintegerrequired- The unique identifier of the page/document. Example: 445566
project_idintegerrequired- The unique identifier of the agent. Example: 12345
label_idsarray- List of label IDs to set for this page (replaces existing labels) Example: [321]
customgpt_document_metadata_updateUpdate the title, URL, description or image shown when a document is cited.WriteUpdate Document Metadata
Update the title, URL, description or image shown when a document is cited. Returns data (id, url, title, description, library_map_snapshot, image). Get the page ID from customgpt_documents_list.
- Idempotent
Inputs
page_idintegerrequired- The unique page id. Example: 445566
project_idintegerrequired- The unique agent id. Example: 12345
descriptionstring- The description of the document used in citations. Example: Current pricing and plan limits
imagestring- The url of the image used in citations. Example: https://example.com/og.png
titlestring- The title of the document used in citations. Example: Pricing FAQ
urlstring- The url of the document used in citations. Example: https://example.com/pricing
customgpt_document_reindexRe-crawl and re-index one web page document so the agent uses its current content.WriteReindex Document
Re-crawl and re-index one web page document so the agent uses its current content. Returns data (updated). Only works for web pages, not uploaded files.
- Idempotent
Inputs
page_idintegerrequired- The unique identifier of the page to reindex. Obtain page IDs from GET /api/v1/projects/{projectId}/pages. Example: 445566
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
customgpt_message_feedback_updateRecord thumbs up, down or neutral feedback on a response.WriteUpdate Message Feedback
Record thumbs up, down or neutral feedback on a response. Returns data (id, conversation_id, user_id, user_query, openai_response, citations, citations_external, citations_hidden, tools, metadata). Get the prompt ID from customgpt_conversation_messages_list.
- Idempotent
Inputs
project_idintegerrequired- The ID of the agent to get the messages for. Example: 12345
prompt_idintegerrequired- The unique identifier of the message to retrieve. Obtain message IDs from GET /api/v1/projects/{projectId}/conversations/{sessionId}/messages. Example: 678901
session_idstringrequired- The session ID of the conversation to get the messages for. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
include_insightsboolean- When true, includes customer_intelligence data in the response. Only has an effect if the lead capture feature is enabled for this agent. Example: true
reactionstring- The new reaction. One of: neutral, disliked, liked. Example: likedone of
neutraldislikedliked
customgpt_message_sendAsk an agent a question using the OpenAI-compatible chat format and get its answer grounded in the agent's knowledge base.WriteSend Message
Ask an agent a question using the OpenAI-compatible chat format and get its answer grounded in the agent's knowledge base. Each call uses one query from the plan. Returns id, object, created, model, usage, choices. Pass the conversation so far in messages, ending with the user's question. Streaming is turned off. Get the agent ID (projectId) from customgpt_agents_list.
Inputs
messagesarrayrequired- The messages to send to the agent. Example: [{"role": "user", "content": "What are your support hours?"}]
project_idintegerrequired- The unique identifier of the agent to send the message to. Example: 12345
external_idstring- External identifier. Example: crm-1001
is_inline_citationboolean- Whether to include inline citations. Example: false
labelsarray- Optional source-label filter. Accepts two formats: (1) Flat array of label IDs or names for OR semantics, e.g. ["A","B","C"]. (2) Array of arrays for AND/OR logic (inner=OR, outer=AND), e.g. [["A","B"],["C","D"]] means (A OR B) AND (C OR D). Max 20 groups, 50 labels per group, 500 total. Invalid values are ignored. Example: ["billing"]
labels_exclusiveboolean- If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages. Example: false
langstring- Response language. Example: en
modelstring- ID of the model to use. Example: example
customgpt_message_verifyStart fact-checking a response's claims against the agent's sources.WriteVerify Message
Start fact-checking a response's claims against the agent's sources. Uses verification credits. Returns data (message). Read results with customgpt_message_claims_get and customgpt_message_trust_score_get.
Inputs
project_idintegerrequired- The ID of the agent to get the messages for. Example: 12345
prompt_idintegerrequired- The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint. Example: 678901
session_idstringrequired- The session ID of the conversation to get the messages for. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
customgpt_persona_version_activateMake an earlier persona version the active persona (saved as a new version).WriteActivate Persona Version
Make an earlier persona version the active persona (saved as a new version). Returns data (updated). Get the version from customgpt_persona_versions_list.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
versionintegerrequired- The version of the persona to set active. Example: 10
customgpt_source_syncRe-sync a sitemap source immediately instead of waiting for its schedule.WriteSync Source Now
Re-sync a sitemap source immediately instead of waiting for its schedule. Returns data (id, created_at, updated_at, type, sub_type, settings, pages). Get the source ID from customgpt_sources_list.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent that owns this source. Example: 12345
source_idintegerrequired- The unique identifier of the source to sync immediately. Obtain source IDs from GET /api/v1/projects/{projectId}/sources. Example: 7788
customgpt_source_updateUpdate a data source's refresh frequency, page handling, JavaScript rendering and image extraction.WriteUpdate Source
Update a data source's refresh frequency, page handling, JavaScript rendering and image extraction. Returns data (id, created_at, updated_at, type, sub_type, settings, pages). Get the source ID from customgpt_sources_list.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
source_idintegerrequired- The unique identifier of the source to update. Example: 7788
allow_extra_timeoutboolean- Allow extra timeout for agent source. Example: false
create_new_pagesboolean- Add new pages to agent automatically during refresh agent source. Example: true
data_refresh_frequencystring- How often the source content is re-fetched and re-indexed. Values: - never: no automatic refresh. - daily / weekly / monthly: refresh on that cadence. - advanced: uses either custom schedule field. One of: never, daily, weekly, monthly, advanced. Example: neverone of
neverdailyweeklymonthlyadvanced executive_jsboolean- Whether the agent source should execute JavaScript. Example: true
image_extraction_typestring- The method used for extracting images from the website. One of: none, sync_from_sitemap, extract_opengraph_images. Example: sync_from_sitemapone of
nonesync_from_sitemapextract_opengraph_images refresh_existing_pagesstring- Refresh existing page during refresh agent source. One of: never, always, if_updated. Example: neverone of
neveralwaysif_updated remove_unexist_pagesboolean- Remove pages from agent automatically during refresh agent source. Example: false
sync_all_imagesboolean- When extracting images from a sitemap, sync every image on a page instead of only the first one. Each synced image consumes one vision credit. Example: false
update_existing_imagesboolean- Whether to update existing images during refresh. Example: false
customgpt_tag_updateRename a tag.WriteRename Tag
Rename a tag. Its user and document assignments are kept. Returns data (id, name). Get the tag ID from customgpt_tags_list.
- Idempotent
Inputs
label_idintegerrequired- The unique identifier of the tag to operate on. Example: 321
project_idintegerrequired- The unique identifier of the agent. Example: 12345
namestring- New tag name (must not start with a digit) Example: Support conversation
customgpt_tag_users_assignSet the users assigned to each tag.WriteAssign Users to Tags
Set the users assigned to each tag. The list sent replaces the current assignment. Returns data (current_page, data, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url). Users are given by email; get them from customgpt_team_members_list.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects. Example: 12345
labelsarray- Tags with the users to assign: each item has the tag id and a users list of user emails, for example [{"id": 321, "users": ["manager@example.com"]}]. Example: [{"id": 321, "users": ["manager@example.com"]}]
customgpt_task_stopStop the response a running task is generating.WriteStop Task
Stop the response a running task is generating. Work already done is kept and billed. Get the task ID from customgpt_tasks_list.
Inputs
project_idintegerrequired- The unique identifier of the agent. Example: 12345
task_idstringrequired- The task ID. Example: task_01HZX5K9ABC
customgpt_task_updateRename a Plan & Act task.WriteUpdate Task
Rename a Plan & Act task. Returns data (id, project_id, name, created_at, updated_at). Get the task ID from customgpt_tasks_list.
- Idempotent
Inputs
namestringrequired- New task name. Example: Support conversation
project_idintegerrequired- The unique identifier of the agent. Example: 12345
task_idstringrequired- The task ID. This is the value returned in data.id when you create a task via POST /tasks. Example: task_01HZX5K9ABC
customgpt_team_invitation_createEmail an invitation to join the current team with a role.WriteInvite Team Member
Email an invitation to join the current team with a role. Returns data (id, email, role_id, team_id, created_at). Get role IDs from the team's roles in CustomGPT. The recipient must accept.
Inputs
emailstring- Email address of the person to invite. Example: teammate@example.com
role_idinteger- Role ID to assign to the invited member. Example: 3
customgpt_agent_deletePermanently delete an agent with its knowledge base, conversations, settings and analytics.DestructiveDelete Agent
Permanently delete an agent with its knowledge base, conversations, settings and analytics. Returns data (deleted). This cannot be undone. Get the agent ID (projectId) from customgpt_agents_list.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
customgpt_conversation_deletePermanently delete a conversation and all its messages.DestructiveDelete Conversation
Permanently delete a conversation and all its messages. Returns data (deleted). Get the session ID from customgpt_conversations_list or customgpt_conversation_create.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
session_idstringrequired- The unique session identifier. Example: f1b9aa61-1c3a-4b3e-9d3c-2f6a0e1c9d77
customgpt_document_deleteRemove a document from an agent's knowledge base.DestructiveDelete Document
Remove a document from an agent's knowledge base. Returns data (deleted). Get the page ID from customgpt_documents_list.
- Idempotent
Inputs
page_idintegerrequired- The unique identifier of the page (document) to delete. Obtain page IDs from GET /api/v1/projects/{projectId}/pages. Example: 445566
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
customgpt_source_deleteDelete a data source and the documents it added.DestructiveDelete Source
Delete a data source and the documents it added. Returns data (deleted). Get the source ID from customgpt_sources_list.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent (formerly known as project). Example: 12345
source_idintegerrequired- The unique identifier of a source. Example: 7788
customgpt_tag_deleteDelete a tag and all its user and document assignments.DestructiveDelete Tag
Delete a tag and all its user and document assignments. Returns data (deleted). Documents left without tags become visible to everyone.
- Idempotent
Inputs
label_idintegerrequired- The unique identifier of the tag to operate on. Example: 321
project_idintegerrequired- The unique identifier of the agent. Example: 12345
customgpt_task_deletePermanently delete a task and its messages.DestructiveDelete Task
Permanently delete a task and its messages. Returns data (deleted). Get the task ID from customgpt_tasks_list.
- Idempotent
Inputs
project_idintegerrequired- The unique identifier of the agent. Example: 12345
task_idstringrequired- The task ID. This is the value returned in data.id when you create a task via POST /tasks. Example: task_01HZX5K9ABC
No tools match.