/customgpt | Type: Application | PCID required: Yes
Tools
customgpt_delete_api_projects_by_projectid
Delete an agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_delete_api_projects_by_projectid_actions_custom_by_actionkey
Delete a custom action. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
actionKey | string | Yes | — | Action key (built-in tool key such as “document_analyst”, or custom action tool_key such as “custom_mcp_connector_abc123”). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
},
"actionKey": {
"type": "string",
"description": "Action key (built-in tool key such as \"document_analyst\", or custom action tool_key such as \"custom_mcp_connector_abc123\")."
}
},
"required": [
"PCID",
"projectId",
"actionKey"
]
}
customgpt_delete_api_projects_by_projectid_children
Bulk unassign child agents. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the Multi-Agent project. |
projectIds | integer[] | No | — | IDs of the child agents to unassign. All IDs must currently be assigned. At least one child must remain after the operation. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the Multi-Agent project."
},
"projectIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of the child agents to unassign. All IDs must currently be assigned. At least one child must remain after the operation."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_delete_api_projects_by_projectid_children_by_childprojectid
Unassign a child agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the Multi-Agent project. |
childProjectId | integer | Yes | — | The unique identifier of the child agent to unassign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the Multi-Agent project."
},
"childProjectId": {
"type": "integer",
"description": "The unique identifier of the child agent to unassign."
}
},
"required": [
"PCID",
"projectId",
"childProjectId"
]
}
customgpt_delete_api_projects_by_projectid_contextual_rag_pages
Delete webpage context pages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
page_ids | string[] | No | — | List of page IDs to delete. If omitted, all pages for the agent are deleted. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"page_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of page IDs to delete. If omitted, all pages for the agent are deleted."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_delete_api_projects_by_projectid_conversations_by_sessionid
Delete conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
sessionId | string | Yes | — | The unique session identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"sessionId": {
"type": "string",
"description": "The unique session identifier."
}
},
"required": [
"PCID",
"projectId",
"sessionId"
]
}
customgpt_delete_api_projects_by_projectid_labels_by_labelid
Delete a label. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
labelId | integer | Yes | — | The unique identifier of the label to operate on. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"labelId": {
"type": "integer",
"description": "The unique identifier of the label to operate on."
}
},
"required": [
"PCID",
"projectId",
"labelId"
]
}
customgpt_delete_api_projects_by_projectid_labels_users
Remove users from labels. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects. |
labels | object[] | No | — | List of labels and users to remove |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects."
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Label ID"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user emails to remove from this label"
}
}
},
"description": "List of labels and users to remove"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_delete_api_projects_by_projectid_licenses_by_licenseid
Delete a license. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
licenseId | integer | Yes | — | The unique identifier of a license. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"licenseId": {
"type": "integer",
"description": "The unique identifier of a license."
}
},
"required": [
"PCID",
"projectId",
"licenseId"
]
}
customgpt_delete_api_projects_by_projectid_pages_by_pageid
Delete a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
pageId | integer | Yes | — | The unique identifier of the page (document) to delete. Obtain page IDs from GET /api/v1/projects/{projectId}/pages. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"pageId": {
"type": "integer",
"description": "The unique identifier of the page (document) to delete. Obtain page IDs from GET /api/v1/projects/{projectId}/pages."
}
},
"required": [
"PCID",
"projectId",
"pageId"
]
}
customgpt_delete_api_projects_by_projectid_sources_by_sourceid
Delete a source. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
sourceId | integer | Yes | — | The unique identifier of a source. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"sourceId": {
"type": "integer",
"description": "The unique identifier of a source."
}
},
"required": [
"PCID",
"projectId",
"sourceId"
]
}
customgpt_delete_api_projects_by_projectid_tasks_by_taskid
Delete task. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
taskId | string | Yes | — | The task ID. This is the value returned in data.id when you create a task via POST /tasks. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"taskId": {
"type": "string",
"description": "The task ID. This is the value returned in `data.id` when you create a task via POST /tasks."
}
},
"required": [
"PCID",
"projectId",
"taskId"
]
}
customgpt_delete_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files_by_fileid
Delete message file. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent |
taskId | string | Yes | — | The task ID |
promptHistoryId | integer | Yes | — | The unique identifier of the message |
fileId | string | Yes | — | UUID of the generated artifact |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent"
},
"taskId": {
"type": "string",
"description": "The task ID"
},
"promptHistoryId": {
"type": "integer",
"description": "The unique identifier of the message"
},
"fileId": {
"type": "string",
"description": "UUID of the generated artifact"
}
},
"required": [
"PCID",
"projectId",
"taskId",
"promptHistoryId",
"fileId"
]
}
customgpt_get_api_limits_usage
Get account limits.Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
customgpt_get_api_preview_by_id
Get citation source preview. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
customgpt_get_api_projects
List all agents. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | 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. |
duration | integer | No | — | The duration of the agents to list. |
order | string | No | — | Sort direction for results. |
orderBy | string | No | — | Field to sort results by. |
width | string | No | — | The width of the embed code. Defaults to 100%. |
height | string | No | — | The height of the embed code. Defaults to 100%. |
name | string | No | — | Filter the results by agent name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "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."
},
"duration": {
"type": "integer",
"description": "The duration of the agents to list."
},
"order": {
"type": "string",
"description": "Sort direction for results.",
"enum": [
"asc",
"desc"
]
},
"orderBy": {
"type": "string",
"description": "Field to sort results by.",
"enum": [
"id",
"created_at"
]
},
"width": {
"type": "string",
"description": "The width of the embed code. Defaults to 100%."
},
"height": {
"type": "string",
"description": "The height of the embed code. Defaults to 100%."
},
"name": {
"type": "string",
"description": "Filter the results by agent name"
}
},
"required": [
"PCID"
]
}
customgpt_get_api_projects_by_projectid
Get agent details. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent to retrieve. Obtain agent IDs from the response of GET /api/v1/projects or POST /api/v1/projects. |
width | string | No | — | The width of the embed code. Defaults to 100%. |
height | string | No | — | The height of the embed code. Defaults to 100%. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent to retrieve. Obtain agent IDs from the response of GET /api/v1/projects or POST /api/v1/projects."
},
"width": {
"type": "string",
"description": "The width of the embed code. Defaults to 100%."
},
"height": {
"type": "string",
"description": "The height of the embed code. Defaults to 100%."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_actions
List agent actions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_children
List child agents. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the Multi-Agent project. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the Multi-Agent project."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_citations_by_citationid
Get citation metadata. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique project identifier. |
citationId | integer | Yes | — | The unique citation identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique project identifier."
},
"citationId": {
"type": "integer",
"description": "The unique citation identifier."
}
},
"required": [
"PCID",
"projectId",
"citationId"
]
}
customgpt_get_api_projects_by_projectid_contextual_rag_pages
List webpage context pages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
url | string | No | — | Filter pages by URL. Returns only the page matching this exact URL. |
limit | integer | No | — | Maximum number of pages to return. Defaults to 50. |
page | integer | No | — | Page number for pagination. Defaults to 1. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"url": {
"type": "string",
"description": "Filter pages by URL. Returns only the page matching this exact URL."
},
"limit": {
"type": "integer",
"description": "Maximum number of pages to return. Defaults to 50."
},
"page": {
"type": "integer",
"description": "Page number for pagination. Defaults to 1."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_conversations
List conversations. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the conversations for |
page | integer | No | — | 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. |
order | string | No | — | Sort direction for results. |
orderBy | string | No | — | Field to sort results by. |
userFilter | string | No | — | Filter conversations by user type. |
name | string | No | — | Filter the results by conversation name |
lastUpdatedAfter | string | No | — | Only conversations that received message(s) after this date will be returned in results. If not set, the parameter is ignored. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the conversations for"
},
"page": {
"type": "integer",
"description": "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."
},
"order": {
"type": "string",
"description": "Sort direction for results.",
"enum": [
"asc",
"desc"
]
},
"orderBy": {
"type": "string",
"description": "Field to sort results by.",
"enum": [
"id",
"created_at"
]
},
"userFilter": {
"type": "string",
"description": "Filter conversations by user type.",
"enum": [
"all",
"anonymous",
"team_member",
"me"
]
},
"name": {
"type": "string",
"description": "Filter the results by conversation name"
},
"lastUpdatedAfter": {
"type": "string",
"description": "Only conversations that received message(s) after this date will be returned in results. If not set, the parameter is ignored."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_conversations_by_sessionid_export
Export conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the converstaions to get the messages for |
format | string | No | — | Export file format. |
isCustomRowsNumber | string | No | — | Set to true to limit the export to a specific number of rows defined by the rowsNumber parameter. When false (default), all matching conversations are exported. |
rowsNumber | integer | No | — | The maximum number of rows to include in the export. Must be a positive integer (minimum: 1). Only applied when isCustomRowsNumber is true. |
startDate | string | No | — | Start date for filtering exported conversations. Format: YYYY-MM-DD (e.g., 2024-01-15). Conversations created on or after this date are included. Omit to include all conversations up to endDate. |
endDate | string | No | — | End date for filtering exported conversations. Format: YYYY-MM-DD (e.g., 2024-03-31). Conversations created on or before this date are included. Omit to include all conversations from startDate onward. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the converstaions to get the messages for"
},
"format": {
"type": "string",
"description": "Export file format.",
"enum": [
"json",
"excel",
"csv",
"pdf"
]
},
"isCustomRowsNumber": {
"type": "string",
"description": "Set to true to limit the export to a specific number of rows defined by the rowsNumber parameter. When false (default), all matching conversations are exported."
},
"rowsNumber": {
"type": "integer",
"description": "The maximum number of rows to include in the export. Must be a positive integer (minimum: 1). Only applied when isCustomRowsNumber is true."
},
"startDate": {
"type": "string",
"description": "Start date for filtering exported conversations. Format: YYYY-MM-DD (e.g., 2024-01-15). Conversations created on or after this date are included. Omit to include all conversations up to endDate."
},
"endDate": {
"type": "string",
"description": "End date for filtering exported conversations. Format: YYYY-MM-DD (e.g., 2024-03-31). Conversations created on or before this date are included. Omit to include all conversations from startDate onward."
}
},
"required": [
"PCID",
"projectId",
"sessionId"
]
}
customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages
Get conversation messages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the converstaions to get the messages for |
page | integer | No | — | Page number to return |
order | string | No | — | Sort direction for messages. |
includeInsights | boolean | No | — | When true, includes customer_intelligence data in the response. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the converstaions to get the messages for"
},
"page": {
"type": "integer",
"description": "Page number to return"
},
"order": {
"type": "string",
"description": "Sort direction for messages.",
"enum": [
"asc",
"desc"
]
},
"includeInsights": {
"type": "boolean",
"description": "When true, includes customer_intelligence data in the response."
}
},
"required": [
"PCID",
"projectId",
"sessionId"
]
}
customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid
Get message details. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the conversation to get the messages for |
promptId | integer | Yes | — | The unique identifier of the message to retrieve. Obtain message IDs from GET /api/v1/projects/{projectId}/conversations/{sessionId}/messages. |
includeInsights | boolean | No | — | When true, includes customer_intelligence data in the response. Only has an effect if the lead capture feature is enabled for this agent. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the conversation to get the messages for"
},
"promptId": {
"type": "integer",
"description": "The unique identifier of the message to retrieve. Obtain message IDs from GET /api/v1/projects/{projectId}/conversations/{sessionId}/messages."
},
"includeInsights": {
"type": "boolean",
"description": "When true, includes customer_intelligence data in the response. Only has an effect if the lead capture feature is enabled for this agent."
}
},
"required": [
"PCID",
"projectId",
"sessionId",
"promptId"
]
}
customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_claims
Get message claims. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the conversation to get the messages for |
promptId | integer | Yes | — | The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the conversation to get the messages for"
},
"promptId": {
"type": "integer",
"description": "The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint."
}
},
"required": [
"PCID",
"projectId",
"sessionId",
"promptId"
]
}
customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_trust_score
Get message trust score. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the conversation to get the messages for |
promptId | integer | Yes | — | The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the conversation to get the messages for"
},
"promptId": {
"type": "integer",
"description": "The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint."
}
},
"required": [
"PCID",
"projectId",
"sessionId",
"promptId"
]
}
customgpt_get_api_projects_by_projectid_labels
List all labels. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the project |
page | integer | No | — | Page number to return. |
limit | integer | No | — | Maximum number of labels to return per page. Maximum is 100. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the project"
},
"page": {
"type": "integer",
"description": "Page number to return."
},
"limit": {
"type": "integer",
"description": "Maximum number of labels to return per page. Maximum is 100."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_labels_by_labelid
Get label details. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
labelId | integer | Yes | — | The unique identifier of the label to operate on. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"labelId": {
"type": "integer",
"description": "The unique identifier of the label to operate on."
}
},
"required": [
"PCID",
"projectId",
"labelId"
]
}
customgpt_get_api_projects_by_projectid_licenses
List licenses. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_licenses_by_licenseid
Get license details. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
licenseId | integer | Yes | — | The unique identifier of a license. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"licenseId": {
"type": "integer",
"description": "The unique identifier of a license."
}
},
"required": [
"PCID",
"projectId",
"licenseId"
]
}
customgpt_get_api_projects_by_projectid_pages
List all documents. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
page | integer | No | — | 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. |
limit | integer | No | — | Limit the number of documents to return. Defaults to 20. |
order | string | No | — | Sort direction for results. |
search | string | No | — | 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. |
crawl_status | string | No | — | Filter pages by crawl status. |
index_status | string | No | — | Filter pages by index status. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
},
"page": {
"type": "integer",
"description": "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."
},
"limit": {
"type": "integer",
"description": "Limit the number of documents to return. Defaults to 20."
},
"order": {
"type": "string",
"description": "Sort direction for results.",
"enum": [
"asc",
"desc"
]
},
"search": {
"type": "string",
"description": "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."
},
"crawl_status": {
"type": "string",
"description": "Filter pages by crawl status.",
"enum": [
"all",
"ok",
"failed",
"n/a",
"queued",
"limited"
]
},
"index_status": {
"type": "string",
"description": "Filter pages by index status.",
"enum": [
"all",
"ok",
"failed",
"n/a",
"queued",
"limited"
]
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_pages_by_pageid_labels
Get document labels. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
pageId | integer | Yes | — | The unique identifier of the page/document. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"pageId": {
"type": "integer",
"description": "The unique identifier of the page/document."
}
},
"required": [
"PCID",
"projectId",
"pageId"
]
}
customgpt_get_api_projects_by_projectid_pages_by_pageid_metadata
Get document metadata. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent id. |
pageId | integer | Yes | — | The unique page id. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent id."
},
"pageId": {
"type": "integer",
"description": "The unique page id."
}
},
"required": [
"PCID",
"projectId",
"pageId"
]
}
customgpt_get_api_projects_by_projectid_reports_analysis
Get analytics chart data. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get analysis for |
filters | string[] | Yes | — | Filters to return graph-ready analysis data for. |
interval | string | No | — | Time interval for aggregating analytics data. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get analysis for"
},
"filters": {
"type": "array",
"items": {
"type": "string",
"enum": [
"queries",
"conversations",
"queries_per_conversation"
]
},
"description": "Filters to return graph-ready analysis data for."
},
"interval": {
"type": "string",
"description": "Time interval for aggregating analytics data.",
"enum": [
"daily",
"weekly"
]
}
},
"required": [
"PCID",
"projectId",
"filters"
]
}
customgpt_get_api_projects_by_projectid_reports_conversations
Get conversation analytics. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get conversations for |
filters | string[] | Yes | — | Filters to return conversations metrics for. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get conversations for"
},
"filters": {
"type": "array",
"items": {
"type": "string",
"enum": [
"total",
"average_queries_per_conversation"
]
},
"description": "Filters to return conversations metrics for."
}
},
"required": [
"PCID",
"projectId",
"filters"
]
}
customgpt_get_api_projects_by_projectid_reports_intelligence
Get customer intelligence. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the project to get customer intelligence for |
page | integer | No | — | Page number to return. |
limit | integer | No | — | Number of items to return per page. Maximum is 100. |
start_date | string | No | — | 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. |
end_date | string | No | — | 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. |
content_source[] | string[] | No | — | Filter results by Content Source (use repeated parameters, e.g. content_source[]=value) |
accuracy | string | No | — | Filter results by Verified Claims Score as range (format: min-max, e.g., 0-100) |
stakeholder_status[] | string[] | No | — | Filter results by Stakeholder Status (use repeated parameters, e.g. stakeholder_status[]=value) |
user_emotion[] | string[] | No | — | Filter results by User Emotion (use repeated parameters, e.g. user_emotion[]=value) |
user_intent[] | string[] | No | — | Filter results by User Intent (use repeated parameters, e.g. user_intent[]=value) |
human_request[] | string[] | No | — | Filter results by Requested Human (use repeated parameters, e.g. human_request[]=value) |
language[] | string[] | No | — | Filter results by Query Language (use repeated parameters, e.g. language[]=value) |
user_id[] | string[] | No | — | Filter results by Query Sent By (use repeated parameters, e.g. user_id[]=value) |
external_id[] | string[] | No | — | Filter results by CRM ID (use repeated parameters, e.g. external_id[]=value) |
country[] | string[] | No | — | Filter results by User Location (use repeated parameters, e.g. country[]=value) |
risk_fidelity[] | string[] | No | — | Filter results by Risk: Fidelity (use repeated parameters, e.g. risk_fidelity[]=value) |
risk_jailbreak[] | string[] | No | — | Filter results by Risk: Jailbreak (use repeated parameters, e.g. risk_jailbreak[]=value) |
risk_prompt_leakage[] | string[] | No | — | Filter results by Risk: Prompt Leakage (use repeated parameters, e.g. risk_prompt_leakage[]=value) |
risk_profanity[] | string[] | No | — | Filter results by Risk: Profanity (use repeated parameters, e.g. risk_profanity[]=value) |
request_source[] | string[] | No | — | Filter results by Deployment (use repeated parameters, e.g. request_source[]=value) |
leads[] | integer[] | No | — | Filter results by Lead Captured (use repeated parameters, e.g. leads[]=value) |
tools[] | string[] | No | — | Filter results by Agentic Actions (use repeated parameters, e.g. tools[]=value) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the project to get customer intelligence for"
},
"page": {
"type": "integer",
"description": "Page number to return."
},
"limit": {
"type": "integer",
"description": "Number of items to return per page. Maximum is 100."
},
"start_date": {
"type": "string",
"description": "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."
},
"end_date": {
"type": "string",
"description": "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."
},
"content_source[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"in-context",
"out-of-context",
"not-used"
]
},
"description": "Filter results by Content Source (use repeated parameters, e.g. content_source[]=value)"
},
"accuracy": {
"type": "string",
"description": "Filter results by Verified Claims Score as range (format: min-max, e.g., 0-100)"
},
"stakeholder_status[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"APPROVED",
"FLAGGED",
"BLOCKED"
]
},
"description": "Filter results by Stakeholder Status (use repeated parameters, e.g. stakeholder_status[]=value)"
},
"user_emotion[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"positive",
"neutral",
"frustration",
"dissatisfaction",
"confusion",
"unclear"
]
},
"description": "Filter results by User Emotion (use repeated parameters, e.g. user_emotion[]=value)"
},
"user_intent[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"informational",
"troubleshooting",
"instructional",
"greetings",
"transactional",
"navigational",
"follow-up",
"unclear"
]
},
"description": "Filter results by User Intent (use repeated parameters, e.g. user_intent[]=value)"
},
"human_request[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"true",
"false",
"unclear"
]
},
"description": "Filter results by Requested Human (use repeated parameters, e.g. human_request[]=value)"
},
"language[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter results by Query Language (use repeated parameters, e.g. language[]=value)"
},
"user_id[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
-1
]
},
"description": "Filter results by Query Sent By (use repeated parameters, e.g. user_id[]=value)"
},
"external_id[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter results by CRM ID (use repeated parameters, e.g. external_id[]=value)"
},
"country[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter results by User Location (use repeated parameters, e.g. country[]=value)"
},
"risk_fidelity[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"unavailable",
"Good",
"Persona failure"
]
},
"description": "Filter results by Risk: Fidelity (use repeated parameters, e.g. risk_fidelity[]=value)"
},
"risk_jailbreak[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"unavailable",
"no_event",
"jailbreak",
"jailbreak_attempt"
]
},
"description": "Filter results by Risk: Jailbreak (use repeated parameters, e.g. risk_jailbreak[]=value)"
},
"risk_prompt_leakage[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"unavailable",
"no_event",
"prompt_leaked",
"prompt_leakage_attempt"
]
},
"description": "Filter results by Risk: Prompt Leakage (use repeated parameters, e.g. risk_prompt_leakage[]=value)"
},
"risk_profanity[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"unavailable",
"no_event",
"detected"
]
},
"description": "Filter results by Risk: Profanity (use repeated parameters, e.g. risk_profanity[]=value)"
},
"request_source[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"web",
"ama",
"iframe",
"api",
"api-openai",
"sdk",
"slack",
"embed",
"livechat",
"sge",
"ai-assistant",
"instant-viewer",
"mcp",
"ama-try",
"onboarding"
]
},
"description": "Filter results by Deployment (use repeated parameters, e.g. request_source[]=value)"
},
"leads[]": {
"type": "array",
"items": {
"type": "integer",
"enum": [
0,
1
]
},
"description": "Filter results by Lead Captured (use repeated parameters, e.g. leads[]=value)"
},
"tools[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter results by Agentic Actions (use repeated parameters, e.g. tools[]=value)"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_reports_leads
Export leads. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the project to get leads export for |
start_date | string | No | — | Start date for the export range (ISO 8601 format) |
end_date | string | No | — | End date for the export range (ISO 8601 format) |
page | integer | No | — | Page number to return. |
limit | integer | No | — | Number of lead records to return per page. Maximum is 100. |
session_id | string | No | — | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the project to get leads export for"
},
"start_date": {
"type": "string",
"description": "Start date for the export range (ISO 8601 format)"
},
"end_date": {
"type": "string",
"description": "End date for the export range (ISO 8601 format)"
},
"page": {
"type": "integer",
"description": "Page number to return."
},
"limit": {
"type": "integer",
"description": "Number of lead records to return per page. Maximum is 100."
},
"session_id": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_reports_leads_by_sessionid_collated
Export a single collated lead for a conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the project to get collated lead for |
sessionId | string | Yes | — | The session identifier of the conversation |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the project to get collated lead for"
},
"sessionId": {
"type": "string",
"description": "The session identifier of the conversation"
}
},
"required": [
"PCID",
"projectId",
"sessionId"
]
}
customgpt_get_api_projects_by_projectid_reports_leads_by_sessionid_export
Export leads for a conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to export leads for |
sessionId | string | Yes | — | The session ID of the conversation to export leads for |
format | string | No | — | Export file format. |
mode | string | No | — | Export mode (every captured lead row or a single merged lead collected during the conversation). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to export leads for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the conversation to export leads for"
},
"format": {
"type": "string",
"description": "Export file format.",
"enum": [
"json",
"excel",
"csv",
"pdf"
]
},
"mode": {
"type": "string",
"description": "Export mode (every captured lead row or a single merged lead collected during the conversation).",
"enum": [
"raw",
"collated"
]
}
},
"required": [
"PCID",
"projectId",
"sessionId"
]
}
customgpt_get_api_projects_by_projectid_reports_queries
Get query analytics. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get queries for |
filters | string[] | Yes | — | Filters to return queries metrics for. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get queries for"
},
"filters": {
"type": "array",
"items": {
"type": "string",
"enum": [
"total",
"query_status"
]
},
"description": "Filters to return queries metrics for."
}
},
"required": [
"PCID",
"projectId",
"filters"
]
}
customgpt_get_api_projects_by_projectid_reports_traffic
Get traffic analytics. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get traffic for |
filters | string[] | Yes | — | Filters to return traffic metrics for. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get traffic for"
},
"filters": {
"type": "array",
"items": {
"type": "string",
"enum": [
"sources"
]
},
"description": "Filters to return traffic metrics for."
}
},
"required": [
"PCID",
"projectId",
"filters"
]
}
customgpt_get_api_projects_by_projectid_settings
Get agent settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_settings_persona_by_version
Get persona version. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
version | integer | Yes | — | The version of the persona to set active. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"version": {
"type": "integer",
"description": "The version of the persona to set active."
}
},
"required": [
"PCID",
"projectId",
"version"
]
}
customgpt_get_api_projects_by_projectid_settings_personas
List persona versions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
page | integer | No | — | Page number to return |
limit | integer | No | — | Limit the number of documents to return. Defaults to 20. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
},
"page": {
"type": "integer",
"description": "Page number to return"
},
"limit": {
"type": "integer",
"description": "Limit the number of documents to return. Defaults to 20."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_sources
List sources. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_stats
Get agent statistics. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_tasks
List tasks. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
page | integer | No | — | 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. |
limit | integer | No | — | Number of results per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"page": {
"type": "integer",
"description": "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."
},
"limit": {
"type": "integer",
"description": "Number of results per page"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_get_api_projects_by_projectid_tasks_by_taskid
Poll task. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
taskId | string | Yes | — | The task ID. This is the value returned in data.id when you create a task via POST /tasks. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"taskId": {
"type": "string",
"description": "The task ID. This is the value returned in `data.id` when you create a task via POST /tasks."
}
},
"required": [
"PCID",
"projectId",
"taskId"
]
}
customgpt_get_api_projects_by_projectid_tasks_by_taskid_export
Export task. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
taskId | string | Yes | — | The task ID. This is the value returned in data.id when you create a task via POST /tasks. |
format | string | No | — | Export file format. Selects how the conversation history (all prompts and agent responses) is serialised in the downloaded file. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"taskId": {
"type": "string",
"description": "The task ID. This is the value returned in `data.id` when you create a task via POST /tasks."
},
"format": {
"type": "string",
"description": "Export file format. Selects how the conversation history (all prompts and agent responses) is serialised in the downloaded file.",
"enum": [
"json",
"excel",
"csv",
"pdf"
]
}
},
"required": [
"PCID",
"projectId",
"taskId"
]
}
customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages
List task messages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent |
taskId | string | Yes | — | The task ID |
page | integer | No | — | Page number to return |
order | string | No | — | Sort direction for messages |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent"
},
"taskId": {
"type": "string",
"description": "The task ID"
},
"page": {
"type": "integer",
"description": "Page number to return"
},
"order": {
"type": "string",
"description": "Sort direction for messages",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"PCID",
"projectId",
"taskId"
]
}
customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid
Get task message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent |
taskId | string | Yes | — | The task ID |
promptHistoryId | integer | Yes | — | The unique identifier of the message |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent"
},
"taskId": {
"type": "string",
"description": "The task ID"
},
"promptHistoryId": {
"type": "integer",
"description": "The unique identifier of the message"
}
},
"required": [
"PCID",
"projectId",
"taskId",
"promptHistoryId"
]
}
customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files
List message files. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent |
taskId | string | Yes | — | The task ID |
promptHistoryId | integer | Yes | — | The unique identifier of the message |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent"
},
"taskId": {
"type": "string",
"description": "The task ID"
},
"promptHistoryId": {
"type": "integer",
"description": "The unique identifier of the message"
}
},
"required": [
"PCID",
"projectId",
"taskId",
"promptHistoryId"
]
}
customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files_by_fileid_download
Download message file. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent |
taskId | string | Yes | — | The task ID |
promptHistoryId | integer | Yes | — | The unique identifier of the message |
fileId | string | Yes | — | UUID of the generated artifact |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent"
},
"taskId": {
"type": "string",
"description": "The task ID"
},
"promptHistoryId": {
"type": "integer",
"description": "The unique identifier of the message"
},
"fileId": {
"type": "string",
"description": "UUID of the generated artifact"
}
},
"required": [
"PCID",
"projectId",
"taskId",
"promptHistoryId",
"fileId"
]
}
customgpt_get_api_user
Get current user profile.Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
customgpt_get_api_user_search_team_member
Search team members. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Email of the team member to search for |
user_id | integer | No | — | User ID of the team member to search for |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "Email of the team member to search for"
},
"user_id": {
"type": "integer",
"description": "User ID of the team member to search for"
}
},
"required": [
"PCID"
]
}
customgpt_patch_api_projects_by_projectid_contextual_rag_messages
Bulk update page messages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
updates | object[] | Yes | — | Array of page message updates. Each entry must include the page ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"updates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The page ID in the Webpage Awareness service."
},
"auto_message": {
"type": "string",
"description": "Auto-generated contextual message for the page. Maximum 500 characters."
},
"display_message": {
"type": "string",
"description": "Custom display message shown to visitors on this page. Maximum 500 characters."
}
},
"required": [
"id"
]
},
"description": "Array of page message updates. Each entry must include the page ID."
}
},
"required": [
"PCID",
"projectId",
"updates"
]
}
customgpt_post_api_projects
Create an agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | string | No | — | Single file upload. Discouraged - use files[] instead for new integrations. |
file_data_retension | boolean | No | — | File data retension |
files[] | string[] | No | — | Multiple file uploads. Submit each file as a separate files[] part in multipart/form-data. Up to 50 files per request, max 100MB each, max 1GB total batch size. |
is_anonymized | boolean | No | — | Anonymized |
is_ocr_enabled | integer | No | — | OCR processing mode: 0 = Disabled, 1 = OCR enabled, 2 = AI Vision |
is_vision_compress_image | boolean | No | — | Whether to compress images for vision processing. |
is_vision_enabled | boolean | No | — | Whether to enable vision processing for images in the file source. |
project_name | string | No | — | Agent name |
sitemap_path | string | No | — | The sitemap path |
use_planner_mode | boolean | No | — | Whether to enable Plan & Act mode for this agent. Defaults to false. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"file": {
"type": "string",
"description": "Single file upload. Discouraged - use `files[]` instead for new integrations."
},
"file_data_retension": {
"type": "boolean",
"description": "File data retension"
},
"files[]": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Multiple file uploads. Submit each file as a separate `files[]` part in multipart/form-data. Up to 50 files per request, max 100MB each, max 1GB total batch size."
},
"is_anonymized": {
"type": "boolean",
"description": "Anonymized"
},
"is_ocr_enabled": {
"type": "integer",
"description": "OCR processing mode: 0 = Disabled, 1 = OCR enabled, 2 = AI Vision",
"enum": [
0,
1,
2
]
},
"is_vision_compress_image": {
"type": "boolean",
"description": "Whether to compress images for vision processing."
},
"is_vision_enabled": {
"type": "boolean",
"description": "Whether to enable vision processing for images in the file source."
},
"project_name": {
"type": "string",
"description": "Agent name"
},
"sitemap_path": {
"type": "string",
"description": "The sitemap path"
},
"use_planner_mode": {
"type": "boolean",
"description": "Whether to enable Plan & Act mode for this agent. Defaults to false."
}
},
"required": [
"PCID"
]
}
customgpt_post_api_projects_by_projectid
Update an agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
are_licenses_allowed | boolean | No | — | Whether project licenses are allowed |
file | string | No | — | Single file upload. Discouraged - use files[] instead for new integrations. |
file_data_retension | boolean | No | — | File data retension |
files[] | string[] | No | — | Multiple file uploads. Submit each file as a separate files[] part in multipart/form-data. Up to 50 files per request, max 100MB each, max 1GB total batch size. |
is_anonymized | boolean | No | — | Anonymized |
is_ocr_enabled | integer | No | — | OCR processing mode: 0 = Disabled, 1 = OCR enabled, 2 = AI Vision |
is_shared | boolean | No | — | Whether the agent is public or not |
is_vision_compress_image | boolean | No | — | Whether to compress images for vision processing. |
is_vision_enabled | boolean | No | — | Whether to enable vision processing for images in the file source. |
project_name | string | No | — | Agent name |
sitemap_path | string | No | — | Sitemap path |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"are_licenses_allowed": {
"type": "boolean",
"description": "Whether project licenses are allowed"
},
"file": {
"type": "string",
"description": "Single file upload. Discouraged - use `files[]` instead for new integrations."
},
"file_data_retension": {
"type": "boolean",
"description": "File data retension"
},
"files[]": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Multiple file uploads. Submit each file as a separate `files[]` part in multipart/form-data. Up to 50 files per request, max 100MB each, max 1GB total batch size."
},
"is_anonymized": {
"type": "boolean",
"description": "Anonymized"
},
"is_ocr_enabled": {
"type": "integer",
"description": "OCR processing mode: 0 = Disabled, 1 = OCR enabled, 2 = AI Vision",
"enum": [
0,
1,
2
]
},
"is_shared": {
"type": "boolean",
"description": "Whether the agent is public or not"
},
"is_vision_compress_image": {
"type": "boolean",
"description": "Whether to compress images for vision processing."
},
"is_vision_enabled": {
"type": "boolean",
"description": "Whether to enable vision processing for images in the file source."
},
"project_name": {
"type": "string",
"description": "Agent name"
},
"sitemap_path": {
"type": "string",
"description": "Sitemap path"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_actions_custom
Create a custom action (MCP). Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
action_type | string | No | — | Custom action type. Currently only MCP connector is supported. |
description | string | No | — | Action description. |
name | string | No | — | Action name. |
settings | object | No | — | Custom action settings. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
},
"action_type": {
"type": "string",
"description": "Custom action type. Currently only MCP connector is supported.",
"enum": [
"mcp_connector"
]
},
"description": {
"type": "string",
"description": "Action description."
},
"name": {
"type": "string",
"description": "Action name."
},
"settings": {
"type": "object",
"description": "Custom action settings.",
"properties": {
"mcp_url": {
"type": "string",
"description": "MCP server URL."
},
"token": {
"type": "string",
"description": "Optional MCP server token."
},
"require_tool_confirmation": {
"type": "boolean",
"description": "Whether user confirmation is required before execution."
}
}
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_chat_completions
Send message (OpenAI format). Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent to send the message to. |
external_id | string | No | — | External identifier |
is_inline_citation | boolean | No | — | Whether to include inline citations |
labels | any[][] | No | — | 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. |
labels_exclusive | boolean | No | — | If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages. |
lang | string | No | — | Response language |
messages | object[] | No | — | The messages to send to the agent |
model | string | No | — | ID of the model to use |
stream | boolean | No | — | Whether to stream the response |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent to send the message to."
},
"external_id": {
"type": "string",
"description": "External identifier"
},
"is_inline_citation": {
"type": "boolean",
"description": "Whether to include inline citations"
},
"labels": {
"type": "array",
"items": {
"type": "array"
},
"description": "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."
},
"labels_exclusive": {
"type": "boolean",
"description": "If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages."
},
"lang": {
"type": "string",
"description": "Response language"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"system",
"user",
"assistant"
],
"description": "The role value"
},
"content": {
"type": "string",
"description": "The content value"
}
}
},
"description": "The messages to send to the agent"
},
"model": {
"type": "string",
"description": "ID of the model to use"
},
"stream": {
"type": "boolean",
"description": "Whether to stream the response"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_children
Assign child agents. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the Multi-Agent project. |
projectIds | integer[] | No | — | IDs of the child agents to assign. Must belong to the same team, must not already be assigned, and must not be Multi-Agent projects themselves. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the Multi-Agent project."
},
"projectIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of the child agents to assign. Must belong to the same team, must not already be assigned, and must not be Multi-Agent projects themselves."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_conversations
Create a conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
name | string | No | — | Conversation name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"name": {
"type": "string",
"description": "Conversation name"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_conversations_by_sessionid_messages
Send message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the converstaions to get the messages for |
stream | boolean | No | — | When true, the response is sent as a stream of data-only server-sent events (SSE) as tokens are generated, terminated by a status: "finish" event. When false, the full response is returned in a single JSON object. See the streaming guide for client implementation examples. |
lang | string | No | — | The ISO 639-1 language code for the response language. Examples: es - Spanish, fr - French, de - German, ja - Japanese. The agent will attempt to respond in this language regardless of the query language. |
external_id | string | No | — | The external ID of the prompt history. |
action_overrides | object | No | — | Override agent actions for this query only. Provide enabled and disabled action IDs. When using multipart/form-data, send action_overrides as a JSON-encoded object. |
agent_capability | string | No | — | Agent capability preset. Values: - fastest-responses — prioritises speed; best for simple, high-volume tasks. - optimal-choice (default) — balances speed and quality for most tasks. - advanced-reasoning — uses extended thinking for multi-step or analytical tasks. - complex-tasks — maximum capability for long-horizon, deeply complex tasks; slowest and most resource-intensive. |
chatbot_model | string | No | — | Agent model to use for the conversation |
custom_context | string | No | — | Custom context to use for the conversation |
custom_persona | string | No | — | Custom persona to use for the conversation |
file | string | No | — | File to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp) |
files[] | string[] | No | — | Multiple files to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp) |
labels_exclusive | boolean | No | — | If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages. |
labels[] | any[][] | No | — | Optional source-label filter (IDs or names). - Single group (OR): labels[0][]=A&labels[0][]=B - Multiple groups (AND-of-ORs, inner OR / outer AND): labels[0][]=A&labels[0][]=B&labels[1][]=C&labels[1][]=D → (A OR B) AND (C OR D) Limits: max 20 groups, 50 per group, 500 total. Unknown labels are dropped; a group emptied by dropping matches nothing. |
prompt | string | No | — | Prompt to send to the agent |
response_source | string | No | — | Controls which knowledge the agent draws from. Values: - default / own_content — agent answers using only your indexed content (recommended). - openai_content — agent supplements your indexed content with general knowledge from the underlying model. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the converstaions to get the messages for"
},
"stream": {
"type": "boolean",
"description": "When true, the response is sent as a stream of data-only server-sent events (SSE) as tokens are generated, terminated by a `status: \"finish\"` event. When false, the full response is returned in a single JSON object. See the streaming guide for client implementation examples."
},
"lang": {
"type": "string",
"description": "The ISO 639-1 language code for the response language. Examples: `es` - Spanish, `fr` - French, `de` - German, `ja` - Japanese. The agent will attempt to respond in this language regardless of the query language."
},
"external_id": {
"type": "string",
"description": "The external ID of the prompt history."
},
"action_overrides": {
"type": "object",
"description": "Override agent actions for this query only. Provide enabled and disabled action IDs. When using multipart/form-data, send action_overrides as a JSON-encoded object.",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action IDs to enable for this request (built-in tool keys or custom tool keys)."
},
"disabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action IDs to disable for this request (built-in tool keys or custom tool keys)."
}
}
},
"agent_capability": {
"type": "string",
"description": "Agent capability preset. Values: - `fastest-responses` — prioritises speed; best for simple, high-volume tasks. - `optimal-choice` (default) — balances speed and quality for most tasks. - `advanced-reasoning` — uses extended thinking for multi-step or analytical tasks. - `complex-tasks` — maximum capability for long-horizon, deeply complex tasks; slowest and most resource-intensive.",
"enum": [
"fastest-responses",
"optimal-choice",
"advanced-reasoning",
"complex-tasks"
]
},
"chatbot_model": {
"type": "string",
"description": "Agent model to use for the conversation",
"enum": [
"gpt-4-1",
"gpt-4-o",
"gpt-5.1-none",
"gpt-5.1-low",
"gpt-5.2-none",
"gpt-5.2-low",
"gpt-5.4-low",
"gpt-4-1-mini",
"gpt-4o-mini",
"claude-4.8-opus",
"claude-4.6-opus",
"claude-4.5-opus",
"claude-4.6-sonnet",
"claude-4.6-sonnet-thinking",
"claude-4.5-sonnet",
"claude-4.5-haiku",
"gpt-o4-mini-low",
"gpt-o4-mini-medium",
"gpt-o4-mini-high",
"gemini-3.1-pro",
"gemini-3-pro",
"gemini-3.5-flash"
]
},
"custom_context": {
"type": "string",
"description": "Custom context to use for the conversation"
},
"custom_persona": {
"type": "string",
"description": "Custom persona to use for the conversation"
},
"file": {
"type": "string",
"description": "File to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp)"
},
"files[]": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Multiple files to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp)"
},
"labels_exclusive": {
"type": "boolean",
"description": "If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages."
},
"labels[]": {
"type": "array",
"items": {
"type": "array"
},
"description": "Optional source-label filter (IDs or names). - Single group (OR): `labels[0][]=A&labels[0][]=B` - Multiple groups (AND-of-ORs, inner OR / outer AND): `labels[0][]=A&labels[0][]=B&labels[1][]=C&labels[1][]=D` → (A OR B) AND (C OR D) Limits: max 20 groups, 50 per group, 500 total. Unknown labels are dropped; a group emptied by dropping matches nothing."
},
"prompt": {
"type": "string",
"description": "Prompt to send to the agent"
},
"response_source": {
"type": "string",
"description": "Controls which knowledge the agent draws from. Values: - `default` / `own_content` — agent answers using only your indexed content (recommended). - `openai_content` — agent supplements your indexed content with general knowledge from the underlying model.",
"enum": [
"default",
"own_content",
"openai_content"
]
}
},
"required": [
"PCID",
"projectId",
"sessionId"
]
}
customgpt_post_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_verify
Verify message accuracy. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the conversation to get the messages for |
promptId | integer | Yes | — | The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the conversation to get the messages for"
},
"promptId": {
"type": "integer",
"description": "The unique identifier of the message to retrieve the Verify Responses data for. Obtain message IDs from the messages list endpoint."
}
},
"required": [
"PCID",
"projectId",
"sessionId",
"promptId"
]
}
customgpt_post_api_projects_by_projectid_labels
Create labels. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects. |
names | string[] | No | — | Label names to create/restore (max 20 characters each, must not start with a digit) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects."
},
"names": {
"type": "array",
"items": {
"type": "string"
},
"description": "Label names to create/restore (max 20 characters each, must not start with a digit)"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_licenses
Create a license. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
name | string | No | — | The name of the license |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"name": {
"type": "string",
"description": "The name of the license"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_pages_by_pageid_reindex
Reindex a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
pageId | integer | Yes | — | The unique identifier of the page to reindex. Obtain page IDs from GET /api/v1/projects/{projectId}/pages. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"pageId": {
"type": "integer",
"description": "The unique identifier of the page to reindex. Obtain page IDs from GET /api/v1/projects/{projectId}/pages."
}
},
"required": [
"PCID",
"projectId",
"pageId"
]
}
customgpt_post_api_projects_by_projectid_replicate
Replicate an agent. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_settings
Update agent settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
body | object | No | — | Update agent settings |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"body": {
"description": "Update agent settings"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_sources
Add a source. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
file | string | No | — | Single file upload as a data source. Discouraged — use files[] instead for new integrations. Supported types include documents, audio files, and images. Images require is_vision_enabled: true on the agent. Max file size: 100 MB. |
file_data_retension | boolean | No | — | File data retension |
files[] | string[] | No | — | Multiple file uploads. Submit each file as a separate files[] part in multipart/form-data. Up to 50 files per request, max 100MB each, max 1GB total batch size. |
image_extraction_type | string | No | — | The method used for extracting images from the website. |
is_anonymized | boolean | No | — | Anonymized |
is_ocr_enabled | integer | No | — | OCR processing mode: 0 = Disabled, 1 = OCR enabled, 2 = AI Vision |
is_vision_compress_image | boolean | No | — | Whether to compress images for vision processing. |
is_vision_enabled | boolean | No | — | Whether to enable vision processing for images in the file source. |
sitemap_path | string | No | — | The sitemap path |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"file": {
"type": "string",
"description": "Single file upload as a data source. Discouraged — use `files[]` instead for new integrations. Supported types include documents, audio files, and images. Images require `is_vision_enabled: true` on the agent. Max file size: 100 MB."
},
"file_data_retension": {
"type": "boolean",
"description": "File data retension"
},
"files[]": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Multiple file uploads. Submit each file as a separate `files[]` part in multipart/form-data. Up to 50 files per request, max 100MB each, max 1GB total batch size."
},
"image_extraction_type": {
"type": "string",
"description": "The method used for extracting images from the website.",
"enum": [
"none",
"sync_from_sitemap"
]
},
"is_anonymized": {
"type": "boolean",
"description": "Anonymized"
},
"is_ocr_enabled": {
"type": "integer",
"description": "OCR processing mode: 0 = Disabled, 1 = OCR enabled, 2 = AI Vision",
"enum": [
0,
1,
2
]
},
"is_vision_compress_image": {
"type": "boolean",
"description": "Whether to compress images for vision processing."
},
"is_vision_enabled": {
"type": "boolean",
"description": "Whether to enable vision processing for images in the file source."
},
"sitemap_path": {
"type": "string",
"description": "The sitemap path"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_post_api_projects_by_projectid_tasks
Create task. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
action_overrides | object | No | — | Override agent actions for this query only. Provide enabled and disabled action IDs. When using multipart/form-data, send action_overrides as a JSON-encoded object. |
agent_capability | string | No | — | Agent capability preset. Values: - fastest-responses — prioritises speed; best for simple, high-volume tasks. - optimal-choice (default) — balances speed and quality for most tasks. - advanced-reasoning — uses extended thinking for multi-step or analytical tasks. - complex-tasks — maximum capability for long-horizon, deeply complex tasks; slowest and most resource-intensive. |
chatbot_model | string | No | — | Agent model to use for the conversation |
custom_context | string | No | — | Custom context to use for the conversation |
custom_persona | string | No | — | Custom persona to use for the conversation |
file | string | No | — | File to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp) |
files[] | string[] | No | — | Multiple files to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp) |
labels_exclusive | boolean | No | — | If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages. |
labels[] | any[][] | No | — | Optional source-label filter (IDs or names). - Single group (OR): labels[0][]=A&labels[0][]=B - Multiple groups (AND-of-ORs, inner OR / outer AND): labels[0][]=A&labels[0][]=B&labels[1][]=C&labels[1][]=D → (A OR B) AND (C OR D) Limits: max 20 groups, 50 per group, 500 total. Unknown labels are dropped; a group emptied by dropping matches nothing. |
name | string | No | — | Task name. Defaults to the truncated prompt if omitted. |
prompt | string | Yes | — | The first prompt for this task. The task runs asynchronously; results stream back via GET /tasks/{taskId} (poll for progress — sessions can run for minutes or longer). |
response_source | string | No | — | Controls which knowledge the agent draws from. Values: - default / own_content — agent answers using only your indexed content (recommended). - openai_content — agent supplements your indexed content with general knowledge from the underlying model. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"action_overrides": {
"type": "object",
"description": "Override agent actions for this query only. Provide enabled and disabled action IDs. When using multipart/form-data, send action_overrides as a JSON-encoded object.",
"properties": {
"enabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action IDs to enable for this request (built-in tool keys or custom tool keys)."
},
"disabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "Action IDs to disable for this request (built-in tool keys or custom tool keys)."
}
}
},
"agent_capability": {
"type": "string",
"description": "Agent capability preset. Values: - `fastest-responses` — prioritises speed; best for simple, high-volume tasks. - `optimal-choice` (default) — balances speed and quality for most tasks. - `advanced-reasoning` — uses extended thinking for multi-step or analytical tasks. - `complex-tasks` — maximum capability for long-horizon, deeply complex tasks; slowest and most resource-intensive.",
"enum": [
"fastest-responses",
"optimal-choice",
"advanced-reasoning",
"complex-tasks"
]
},
"chatbot_model": {
"type": "string",
"description": "Agent model to use for the conversation",
"enum": [
"gpt-4-1",
"gpt-4-o",
"gpt-5.1-none",
"gpt-5.1-low",
"gpt-5.2-none",
"gpt-5.2-low",
"gpt-5.4-low",
"gpt-4-1-mini",
"gpt-4o-mini",
"claude-4.8-opus",
"claude-4.6-opus",
"claude-4.5-opus",
"claude-4.6-sonnet",
"claude-4.6-sonnet-thinking",
"claude-4.5-sonnet",
"claude-4.5-haiku",
"gpt-o4-mini-low",
"gpt-o4-mini-medium",
"gpt-o4-mini-high",
"gemini-3.1-pro",
"gemini-3-pro",
"gemini-3.5-flash"
]
},
"custom_context": {
"type": "string",
"description": "Custom context to use for the conversation"
},
"custom_persona": {
"type": "string",
"description": "Custom persona to use for the conversation"
},
"file": {
"type": "string",
"description": "File to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp)"
},
"files[]": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Multiple files to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp)"
},
"labels_exclusive": {
"type": "boolean",
"description": "If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages."
},
"labels[]": {
"type": "array",
"items": {
"type": "array"
},
"description": "Optional source-label filter (IDs or names). - Single group (OR): `labels[0][]=A&labels[0][]=B` - Multiple groups (AND-of-ORs, inner OR / outer AND): `labels[0][]=A&labels[0][]=B&labels[1][]=C&labels[1][]=D` → (A OR B) AND (C OR D) Limits: max 20 groups, 50 per group, 500 total. Unknown labels are dropped; a group emptied by dropping matches nothing."
},
"name": {
"type": "string",
"description": "Task name. Defaults to the truncated prompt if omitted."
},
"prompt": {
"type": "string",
"description": "The first prompt for this task. The task runs asynchronously; results stream back via GET /tasks/{taskId} (poll for progress — sessions can run for minutes or longer)."
},
"response_source": {
"type": "string",
"description": "Controls which knowledge the agent draws from. Values: - `default` / `own_content` — agent answers using only your indexed content (recommended). - `openai_content` — agent supplements your indexed content with general knowledge from the underlying model.",
"enum": [
"default",
"own_content",
"openai_content"
]
}
},
"required": [
"PCID",
"projectId",
"prompt"
]
}
customgpt_post_api_projects_by_projectid_tasks_by_taskid_messages
Send follow-up message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
taskId | string | Yes | — | The task ID. |
chatbot_model | string | No | — | Agent model to use for the task |
custom_context | string | No | — | Custom context to use for the task |
custom_persona | string | No | — | Custom persona to use for the task |
files[] | string[] | No | — | Multiple files to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp) |
labels_exclusive | boolean | No | — | If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages. |
labels[] | any[][] | No | — | Optional source-label filter (IDs or names). - Single group (OR): labels[0][]=A&labels[0][]=B - Multiple groups (AND-of-ORs, inner OR / outer AND): labels[0][]=A&labels[0][]=B&labels[1][]=C&labels[1][]=D → (A OR B) AND (C OR D) Limits: max 20 groups, 50 per group, 500 total. Unknown labels are dropped; a group emptied by dropping matches nothing. |
prompt | string | Yes | — | Prompt to send to the agent |
response_source | string | No | — | Controls which knowledge the agent draws from. Values: - default / own_content — agent answers using only your indexed content (recommended). - openai_content — agent supplements your indexed content with general knowledge from the underlying model. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"taskId": {
"type": "string",
"description": "The task ID."
},
"chatbot_model": {
"type": "string",
"description": "Agent model to use for the task",
"enum": [
"gpt-4-1",
"gpt-4-o",
"gpt-5.1-none",
"gpt-5.1-low",
"gpt-5.2-none",
"gpt-5.2-low",
"gpt-5.4-low",
"gpt-4-1-mini",
"gpt-4o-mini",
"claude-4.8-opus",
"claude-4.6-opus",
"claude-4.5-opus",
"claude-4.6-sonnet",
"claude-4.6-sonnet-thinking",
"claude-4.5-sonnet",
"claude-4.5-haiku",
"gpt-o4-mini-low",
"gpt-o4-mini-medium",
"gpt-o4-mini-high",
"gemini-3.1-pro",
"gemini-3-pro",
"gemini-3.5-flash"
]
},
"custom_context": {
"type": "string",
"description": "Custom context to use for the task"
},
"custom_persona": {
"type": "string",
"description": "Custom persona to use for the task"
},
"files[]": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Multiple files to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp)"
},
"labels_exclusive": {
"type": "boolean",
"description": "If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages."
},
"labels[]": {
"type": "array",
"items": {
"type": "array"
},
"description": "Optional source-label filter (IDs or names). - Single group (OR): `labels[0][]=A&labels[0][]=B` - Multiple groups (AND-of-ORs, inner OR / outer AND): `labels[0][]=A&labels[0][]=B&labels[1][]=C&labels[1][]=D` → (A OR B) AND (C OR D) Limits: max 20 groups, 50 per group, 500 total. Unknown labels are dropped; a group emptied by dropping matches nothing."
},
"prompt": {
"type": "string",
"description": "Prompt to send to the agent"
},
"response_source": {
"type": "string",
"description": "Controls which knowledge the agent draws from. Values: - `default` / `own_content` — agent answers using only your indexed content (recommended). - `openai_content` — agent supplements your indexed content with general knowledge from the underlying model.",
"enum": [
"default",
"own_content",
"openai_content"
]
}
},
"required": [
"PCID",
"projectId",
"taskId",
"prompt"
]
}
customgpt_post_api_user
Update user profile. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | No | — | Update user account info |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "Update user account info"
}
},
"required": [
"PCID"
]
}
customgpt_put_api_projects_by_projectid_actions_builtin_by_actionkey_settings
Update built-in action settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
actionKey | string | Yes | — | Action key (built-in tool key such as “document_analyst”, or custom action tool_key such as “custom_mcp_connector_abc123”). |
settings | object | No | — | Settings for the specified built-in action. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
},
"actionKey": {
"type": "string",
"description": "Action key (built-in tool key such as \"document_analyst\", or custom action tool_key such as \"custom_mcp_connector_abc123\")."
},
"settings": {
"type": "object",
"description": "Settings for the specified built-in action.",
"properties": {
"document_source": {
"type": "string",
"description": "Document Source",
"enum": [
"both",
"knowledge_base",
"attachments"
]
},
"allowed_file_types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pdf",
"docx",
"doc",
"odt",
"txt",
"jpg",
"jpeg",
"png",
"webp"
]
},
"description": "Allowed File Types"
},
"max_file_size": {
"type": "integer",
"description": "Max File Size"
},
"max_files_per_prompt": {
"type": "integer",
"description": "Max Files Per Prompt"
},
"max_file_length": {
"type": "integer",
"description": "Max File Length"
},
"max_image_size": {
"type": "integer",
"description": "Max Image Size"
},
"enable_reranker": {
"type": "boolean",
"description": "Enable Reranker"
},
"target_url": {
"type": "string",
"description": "Target Url"
},
"required_fields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"email",
"phone_number",
"company"
]
},
"description": "Required Fields"
},
"extra_options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Extra Options"
},
"is_collect_utm_tags_enabled": {
"type": "boolean",
"description": "Is Collect Utm Tags Enabled"
},
"use_case": {
"type": "string",
"description": "Use Case"
},
"custom_use_case": {
"type": "string",
"description": "Custom Use Case"
},
"button_triggers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"every_response",
"no_answer",
"user_request"
]
},
"description": "Button Triggers"
},
"extra_trigger_options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Extra Trigger Options"
},
"button_title": {
"type": "string",
"description": "Button Title"
},
"cta_value": {
"type": "string",
"description": "Cta Value"
}
}
}
},
"required": [
"PCID",
"projectId",
"actionKey"
]
}
customgpt_put_api_projects_by_projectid_actions_custom_by_actionkey
Update a custom action configuration. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent identifier. |
actionKey | string | Yes | — | Action key (built-in tool key such as “document_analyst”, or custom action tool_key such as “custom_mcp_connector_abc123”). |
action_type | string | No | — | Custom action type. |
description | string | No | — | Custom action description. |
is_enabled | boolean | No | — | Whether the custom action is enabled. |
name | string | No | — | Custom action name. |
settings | object | No | — | Custom MCP settings. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
},
"actionKey": {
"type": "string",
"description": "Action key (built-in tool key such as \"document_analyst\", or custom action tool_key such as \"custom_mcp_connector_abc123\")."
},
"action_type": {
"type": "string",
"description": "Custom action type.",
"enum": [
"mcp_connector"
]
},
"description": {
"type": "string",
"description": "Custom action description."
},
"is_enabled": {
"type": "boolean",
"description": "Whether the custom action is enabled."
},
"name": {
"type": "string",
"description": "Custom action name."
},
"settings": {
"type": "object",
"description": "Custom MCP settings.",
"properties": {
"mcp_url": {
"type": "string",
"description": "MCP server URL."
},
"token": {
"type": "string",
"description": "Optional MCP server token."
},
"require_tool_confirmation": {
"type": "boolean",
"description": "Whether user confirmation is required before execution."
}
}
}
},
"required": [
"PCID",
"projectId",
"actionKey"
]
}
customgpt_put_api_projects_by_projectid_conversations_by_sessionid
Update conversation. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
sessionId | string | Yes | — | The unique session identifier. |
name | string | No | — | The new name of the conversation |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"sessionId": {
"type": "string",
"description": "The unique session identifier."
},
"name": {
"type": "string",
"description": "The new name of the conversation"
}
},
"required": [
"PCID",
"projectId",
"sessionId"
]
}
customgpt_put_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_feedback
Update message feedback. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The ID of the agent to get the messages for |
sessionId | string | Yes | — | The session ID of the conversation to get the messages for |
promptId | integer | Yes | — | The unique identifier of the message to retrieve. Obtain message IDs from GET /api/v1/projects/{projectId}/conversations/{sessionId}/messages. |
includeInsights | boolean | No | — | When true, includes customer_intelligence data in the response. Only has an effect if the lead capture feature is enabled for this agent. |
reaction | string | No | — | The new reaction |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The ID of the agent to get the messages for"
},
"sessionId": {
"type": "string",
"description": "The session ID of the conversation to get the messages for"
},
"promptId": {
"type": "integer",
"description": "The unique identifier of the message to retrieve. Obtain message IDs from GET /api/v1/projects/{projectId}/conversations/{sessionId}/messages."
},
"includeInsights": {
"type": "boolean",
"description": "When true, includes customer_intelligence data in the response. Only has an effect if the lead capture feature is enabled for this agent."
},
"reaction": {
"type": "string",
"description": "The new reaction",
"enum": [
"neutral",
"disliked",
"liked"
]
}
},
"required": [
"PCID",
"projectId",
"sessionId",
"promptId"
]
}
customgpt_put_api_projects_by_projectid_labels
Assign users to a label. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects. |
labels | object[] | No | — | List of labels with users to assign |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent. You can find this in the CustomGPT dashboard or from the response of POST /api/v1/projects."
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Label ID (must belong to this project)"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user emails to assign to this label"
}
}
},
"description": "List of labels with users to assign"
}
},
"required": [
"PCID",
"projectId"
]
}
customgpt_put_api_projects_by_projectid_labels_by_labelid
Update a label name. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
labelId | integer | Yes | — | The unique identifier of the label to operate on. |
name | string | No | — | New label name (must not start with a digit) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"labelId": {
"type": "integer",
"description": "The unique identifier of the label to operate on."
},
"name": {
"type": "string",
"description": "New label name (must not start with a digit)"
}
},
"required": [
"PCID",
"projectId",
"labelId"
]
}
customgpt_put_api_projects_by_projectid_licenses_by_licenseid
Update a license. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
licenseId | integer | Yes | — | The unique identifier of a license. |
name | string | No | — | The new name of the license |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"licenseId": {
"type": "integer",
"description": "The unique identifier of a license."
},
"name": {
"type": "string",
"description": "The new name of the license"
}
},
"required": [
"PCID",
"projectId",
"licenseId"
]
}
customgpt_put_api_projects_by_projectid_pages_by_pageid_labels
Replace document labels. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
pageId | integer | Yes | — | The unique identifier of the page/document. |
label_ids | integer[] | No | — | List of label IDs to set for this page (replaces existing labels) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"pageId": {
"type": "integer",
"description": "The unique identifier of the page/document."
},
"label_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of label IDs to set for this page (replaces existing labels)"
}
},
"required": [
"PCID",
"projectId",
"pageId"
]
}
customgpt_put_api_projects_by_projectid_pages_by_pageid_metadata
Update document metadata. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique agent id. |
pageId | integer | Yes | — | The unique page id. |
description | string | No | — | The description of the document used in citations |
image | string | No | — | The url of the image used in citations |
title | string | No | — | The title of the document used in citations |
url | string | No | — | The url of the document used in citations |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent id."
},
"pageId": {
"type": "integer",
"description": "The unique page id."
},
"description": {
"type": "string",
"description": "The description of the document used in citations"
},
"image": {
"type": "string",
"description": "The url of the image used in citations"
},
"title": {
"type": "string",
"description": "The title of the document used in citations"
},
"url": {
"type": "string",
"description": "The url of the document used in citations"
}
},
"required": [
"PCID",
"projectId",
"pageId"
]
}
customgpt_put_api_projects_by_projectid_settings_persona_activate_by_version
Activate a persona version. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
version | integer | Yes | — | The version of the persona to set active. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"version": {
"type": "integer",
"description": "The version of the persona to set active."
}
},
"required": [
"PCID",
"projectId",
"version"
]
}
customgpt_put_api_projects_by_projectid_sources_by_sourceid
Update source settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent (formerly known as project). |
sourceId | integer | Yes | — | The unique identifier of the source to update. |
allow_extra_timeout | boolean | No | — | Allow extra timeout for agent source |
create_new_pages | boolean | No | — | Add new pages to agent automatically during refresh agent source |
data_refresh_frequency | string | No | — | 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 the custom schedule defined in the refresh_schedule field. |
executive_js | boolean | No | — | Whether the agent source should execute JavaScript |
image_extraction_type | string | No | — | The method used for extracting images from the website. |
refresh_existing_pages | string | No | — | Refresh existing page during refresh agent source |
refresh_schedule | object | No | — | Custom schedule for advanced data frequency |
remove_unexist_pages | boolean | No | — | Remove pages from agent automatically during refresh agent source |
update_existing_images | boolean | No | — | Whether to update existing images during refresh. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent (formerly known as project)."
},
"sourceId": {
"type": "integer",
"description": "The unique identifier of the source to update."
},
"allow_extra_timeout": {
"type": "boolean",
"description": "Allow extra timeout for agent source"
},
"create_new_pages": {
"type": "boolean",
"description": "Add new pages to agent automatically during refresh agent source"
},
"data_refresh_frequency": {
"type": "string",
"description": "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 the custom schedule defined in the `refresh_schedule` field.",
"enum": [
"never",
"daily",
"weekly",
"monthly",
"advanced"
]
},
"executive_js": {
"type": "boolean",
"description": "Whether the agent source should execute JavaScript"
},
"image_extraction_type": {
"type": "string",
"description": "The method used for extracting images from the website.",
"enum": [
"none",
"sync_from_sitemap"
]
},
"refresh_existing_pages": {
"type": "string",
"description": "Refresh existing page during refresh agent source",
"enum": [
"never",
"always",
"if_updated"
]
},
"refresh_schedule": {
"type": "object",
"description": "Custom schedule for advanced data frequency",
"properties": {
"days": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Index of days in which sitemap should be refreshed. Starts from 0 (Sunday) to 6 (Saturday)."
},
"hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of times in which sitemap should be refreshed. Must be in HH:MM format."
}
}
},
"remove_unexist_pages": {
"type": "boolean",
"description": "Remove pages from agent automatically during refresh agent source"
},
"update_existing_images": {
"type": "boolean",
"description": "Whether to update existing images during refresh."
}
},
"required": [
"PCID",
"projectId",
"sourceId"
]
}
customgpt_put_api_projects_by_projectid_sources_by_sourceid_instant_sync
Trigger instant source sync. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent that owns this source. |
sourceId | integer | Yes | — | The unique identifier of the source to sync immediately. Obtain source IDs from GET /api/v1/projects/{projectId}/sources. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent that owns this source."
},
"sourceId": {
"type": "integer",
"description": "The unique identifier of the source to sync immediately. Obtain source IDs from GET /api/v1/projects/{projectId}/sources."
}
},
"required": [
"PCID",
"projectId",
"sourceId"
]
}
customgpt_put_api_projects_by_projectid_tasks_by_taskid
Update task. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectId | integer | Yes | — | The unique identifier of the agent. |
taskId | string | Yes | — | The task ID. This is the value returned in data.id when you create a task via POST /tasks. |
name | string | Yes | — | New task name. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
},
"taskId": {
"type": "string",
"description": "The task ID. This is the value returned in `data.id` when you create a task via POST /tasks."
},
"name": {
"type": "string",
"description": "New task name."
}
},
"required": [
"PCID",
"projectId",
"taskId",
"name"
]
}