> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# customgpt
> CustomGPT AI agents
**Server path:** `/customgpt` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| [`customgpt_delete_api_projects_by_projectid`](#customgpt_delete_api_projects_by_projectid) | Delete an agent. |
| [`customgpt_delete_api_projects_by_projectid_actions_custom_by_actionkey`](#customgpt_delete_api_projects_by_projectid_actions_custom_by_actionkey) | Delete a custom action. |
| [`customgpt_delete_api_projects_by_projectid_children`](#customgpt_delete_api_projects_by_projectid_children) | Bulk unassign child agents. |
| [`customgpt_delete_api_projects_by_projectid_children_by_childprojectid`](#customgpt_delete_api_projects_by_projectid_children_by_childprojectid) | Unassign a child agent. |
| [`customgpt_delete_api_projects_by_projectid_contextual_rag_pages`](#customgpt_delete_api_projects_by_projectid_contextual_rag_pages) | Delete webpage context pages. |
| [`customgpt_delete_api_projects_by_projectid_conversations_by_sessionid`](#customgpt_delete_api_projects_by_projectid_conversations_by_sessionid) | Delete conversation. |
| [`customgpt_delete_api_projects_by_projectid_labels_by_labelid`](#customgpt_delete_api_projects_by_projectid_labels_by_labelid) | Delete a label. |
| [`customgpt_delete_api_projects_by_projectid_labels_users`](#customgpt_delete_api_projects_by_projectid_labels_users) | Remove users from labels. |
| [`customgpt_delete_api_projects_by_projectid_licenses_by_licenseid`](#customgpt_delete_api_projects_by_projectid_licenses_by_licenseid) | Delete a license. |
| [`customgpt_delete_api_projects_by_projectid_pages_by_pageid`](#customgpt_delete_api_projects_by_projectid_pages_by_pageid) | Delete a document. |
| [`customgpt_delete_api_projects_by_projectid_settings_persona_by_version_sub_personas_by_slug`](#customgpt_delete_api_projects_by_projectid_settings_persona_by_version_sub_personas_by_slug) | Delete sub-persona override. |
| [`customgpt_delete_api_projects_by_projectid_sources_by_sourceid`](#customgpt_delete_api_projects_by_projectid_sources_by_sourceid) | Delete a source. |
| [`customgpt_delete_api_projects_by_projectid_tasks_by_taskid`](#customgpt_delete_api_projects_by_projectid_tasks_by_taskid) | Delete task. |
| [`customgpt_delete_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files_by_fileid`](#customgpt_delete_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files_by_fileid) | Delete message file. |
| [`customgpt_delete_api_teams_invitations_by_invitationid`](#customgpt_delete_api_teams_invitations_by_invitationid) | Cancel an invitation. |
| [`customgpt_delete_api_teams_members_by_userid`](#customgpt_delete_api_teams_members_by_userid) | Remove a team member. |
| [`customgpt_get_api_billing_invoices`](#customgpt_get_api_billing_invoices) | List invoices. |
| [`customgpt_get_api_billing_invoices_by_invoiceid_download`](#customgpt_get_api_billing_invoices_by_invoiceid_download) | Download an invoice. |
| [`customgpt_get_api_billing_payment_methods`](#customgpt_get_api_billing_payment_methods) | List payment methods. |
| [`customgpt_get_api_billing_plan`](#customgpt_get_api_billing_plan) | Get current plan details. |
| [`customgpt_get_api_limits_usage`](#customgpt_get_api_limits_usage) | Get account limits. |
| [`customgpt_get_api_preview_by_id`](#customgpt_get_api_preview_by_id) | Get citation source preview. |
| [`customgpt_get_api_projects`](#customgpt_get_api_projects) | List all agents. |
| [`customgpt_get_api_projects_by_projectid`](#customgpt_get_api_projects_by_projectid) | Get agent details. |
| [`customgpt_get_api_projects_by_projectid_actions`](#customgpt_get_api_projects_by_projectid_actions) | List agent actions. |
| [`customgpt_get_api_projects_by_projectid_children`](#customgpt_get_api_projects_by_projectid_children) | List child agents. |
| [`customgpt_get_api_projects_by_projectid_citations_by_citationid`](#customgpt_get_api_projects_by_projectid_citations_by_citationid) | Get citation metadata. |
| [`customgpt_get_api_projects_by_projectid_contextual_rag_pages`](#customgpt_get_api_projects_by_projectid_contextual_rag_pages) | List webpage context pages. |
| [`customgpt_get_api_projects_by_projectid_conversations`](#customgpt_get_api_projects_by_projectid_conversations) | List conversations. |
| [`customgpt_get_api_projects_by_projectid_conversations_by_sessionid_export`](#customgpt_get_api_projects_by_projectid_conversations_by_sessionid_export) | Export conversation. |
| [`customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages`](#customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages) | Get conversation messages. |
| [`customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid`](#customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid) | Get message details. |
| [`customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_claims`](#customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_claims) | Get message claims. |
| [`customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_trust_score`](#customgpt_get_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_trust_score) | Get message trust score. |
| [`customgpt_get_api_projects_by_projectid_deployment`](#customgpt_get_api_projects_by_projectid_deployment) | Get deployment settings. |
| [`customgpt_get_api_projects_by_projectid_labels`](#customgpt_get_api_projects_by_projectid_labels) | List all labels. |
| [`customgpt_get_api_projects_by_projectid_labels_by_labelid`](#customgpt_get_api_projects_by_projectid_labels_by_labelid) | Get label details. |
| [`customgpt_get_api_projects_by_projectid_licenses`](#customgpt_get_api_projects_by_projectid_licenses) | List licenses. |
| [`customgpt_get_api_projects_by_projectid_licenses_by_licenseid`](#customgpt_get_api_projects_by_projectid_licenses_by_licenseid) | Get license details. |
| [`customgpt_get_api_projects_by_projectid_pages`](#customgpt_get_api_projects_by_projectid_pages) | List all documents. |
| [`customgpt_get_api_projects_by_projectid_pages_by_pageid_labels`](#customgpt_get_api_projects_by_projectid_pages_by_pageid_labels) | Get document labels. |
| [`customgpt_get_api_projects_by_projectid_pages_by_pageid_metadata`](#customgpt_get_api_projects_by_projectid_pages_by_pageid_metadata) | Get document metadata. |
| [`customgpt_get_api_projects_by_projectid_reports_analysis`](#customgpt_get_api_projects_by_projectid_reports_analysis) | Get analytics chart data. |
| [`customgpt_get_api_projects_by_projectid_reports_conversations`](#customgpt_get_api_projects_by_projectid_reports_conversations) | Get conversation analytics. |
| [`customgpt_get_api_projects_by_projectid_reports_intelligence`](#customgpt_get_api_projects_by_projectid_reports_intelligence) | Get customer intelligence. |
| [`customgpt_get_api_projects_by_projectid_reports_leads`](#customgpt_get_api_projects_by_projectid_reports_leads) | Export leads. |
| [`customgpt_get_api_projects_by_projectid_reports_leads_by_sessionid_collated`](#customgpt_get_api_projects_by_projectid_reports_leads_by_sessionid_collated) | Export a single collated lead for a conversation. |
| [`customgpt_get_api_projects_by_projectid_reports_leads_by_sessionid_export`](#customgpt_get_api_projects_by_projectid_reports_leads_by_sessionid_export) | Export leads for a conversation. |
| [`customgpt_get_api_projects_by_projectid_reports_queries`](#customgpt_get_api_projects_by_projectid_reports_queries) | Get query analytics. |
| [`customgpt_get_api_projects_by_projectid_reports_traffic`](#customgpt_get_api_projects_by_projectid_reports_traffic) | Get traffic analytics. |
| [`customgpt_get_api_projects_by_projectid_settings`](#customgpt_get_api_projects_by_projectid_settings) | Get agent settings. |
| [`customgpt_get_api_projects_by_projectid_settings_persona_by_version`](#customgpt_get_api_projects_by_projectid_settings_persona_by_version) | Get persona version. |
| [`customgpt_get_api_projects_by_projectid_settings_persona_by_version_sub_personas`](#customgpt_get_api_projects_by_projectid_settings_persona_by_version_sub_personas) | List sub-personas. |
| [`customgpt_get_api_projects_by_projectid_settings_personas`](#customgpt_get_api_projects_by_projectid_settings_personas) | List persona versions. |
| [`customgpt_get_api_projects_by_projectid_sources`](#customgpt_get_api_projects_by_projectid_sources) | List sources. |
| [`customgpt_get_api_projects_by_projectid_stats`](#customgpt_get_api_projects_by_projectid_stats) | Get agent statistics. |
| [`customgpt_get_api_projects_by_projectid_tasks`](#customgpt_get_api_projects_by_projectid_tasks) | List tasks. |
| [`customgpt_get_api_projects_by_projectid_tasks_by_taskid`](#customgpt_get_api_projects_by_projectid_tasks_by_taskid) | Poll task. |
| [`customgpt_get_api_projects_by_projectid_tasks_by_taskid_export`](#customgpt_get_api_projects_by_projectid_tasks_by_taskid_export) | Export task. |
| [`customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages`](#customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages) | List task messages. |
| [`customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid`](#customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid) | Get task message. |
| [`customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files`](#customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files) | List message files. |
| [`customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files_by_fileid_download`](#customgpt_get_api_projects_by_projectid_tasks_by_taskid_messages_by_prompthistoryid_files_by_fileid_download) | Download message file. |
| [`customgpt_get_api_teams`](#customgpt_get_api_teams) | List all teams the authenticated user belongs to. |
| [`customgpt_get_api_teams_invitations`](#customgpt_get_api_teams_invitations) | List pending invitations. |
| [`customgpt_get_api_teams_members`](#customgpt_get_api_teams_members) | List team members. |
| [`customgpt_get_api_teams_roles`](#customgpt_get_api_teams_roles) | List roles. |
| [`customgpt_get_api_user`](#customgpt_get_api_user) | Get current user profile. |
| [`customgpt_get_api_user_search_team_member`](#customgpt_get_api_user_search_team_member) | Search team members. |
| [`customgpt_patch_api_projects_by_projectid_contextual_rag_messages`](#customgpt_patch_api_projects_by_projectid_contextual_rag_messages) | Bulk update page messages. |
| [`customgpt_patch_api_projects_by_projectid_deployment_by_section`](#customgpt_patch_api_projects_by_projectid_deployment_by_section) | Update deployment settings. |
| [`customgpt_patch_api_projects_by_projectid_settings_persona_by_version_sub_personas_by_slug`](#customgpt_patch_api_projects_by_projectid_settings_persona_by_version_sub_personas_by_slug) | Update sub-persona override. |
| [`customgpt_post_api_projects`](#customgpt_post_api_projects) | Create an agent. |
| [`customgpt_post_api_projects_by_projectid`](#customgpt_post_api_projects_by_projectid) | Update an agent. |
| [`customgpt_post_api_projects_by_projectid_actions_custom`](#customgpt_post_api_projects_by_projectid_actions_custom) | Create a custom action (MCP). |
| [`customgpt_post_api_projects_by_projectid_chat_completions`](#customgpt_post_api_projects_by_projectid_chat_completions) | Send message (OpenAI format). |
| [`customgpt_post_api_projects_by_projectid_children`](#customgpt_post_api_projects_by_projectid_children) | Assign child agents. |
| [`customgpt_post_api_projects_by_projectid_conversations`](#customgpt_post_api_projects_by_projectid_conversations) | Create a conversation. |
| [`customgpt_post_api_projects_by_projectid_conversations_by_sessionid_messages`](#customgpt_post_api_projects_by_projectid_conversations_by_sessionid_messages) | Send message. |
| [`customgpt_post_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_verify`](#customgpt_post_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_verify) | Verify message accuracy. |
| [`customgpt_post_api_projects_by_projectid_labels`](#customgpt_post_api_projects_by_projectid_labels) | Create labels. |
| [`customgpt_post_api_projects_by_projectid_licenses`](#customgpt_post_api_projects_by_projectid_licenses) | Create a license. |
| [`customgpt_post_api_projects_by_projectid_pages_by_pageid_reindex`](#customgpt_post_api_projects_by_projectid_pages_by_pageid_reindex) | Reindex a document. |
| [`customgpt_post_api_projects_by_projectid_replicate`](#customgpt_post_api_projects_by_projectid_replicate) | Replicate an agent. |
| [`customgpt_post_api_projects_by_projectid_settings`](#customgpt_post_api_projects_by_projectid_settings) | Update agent settings. |
| [`customgpt_post_api_projects_by_projectid_sources`](#customgpt_post_api_projects_by_projectid_sources) | Add a source. |
| [`customgpt_post_api_projects_by_projectid_tasks`](#customgpt_post_api_projects_by_projectid_tasks) | Create task. |
| [`customgpt_post_api_projects_by_projectid_tasks_by_taskid_messages`](#customgpt_post_api_projects_by_projectid_tasks_by_taskid_messages) | Send follow-up message. |
| [`customgpt_post_api_projects_by_projectid_tasks_by_taskid_tool_outputs`](#customgpt_post_api_projects_by_projectid_tasks_by_taskid_tool_outputs) | Submit tool outputs. |
| [`customgpt_post_api_teams_by_teamid_switch`](#customgpt_post_api_teams_by_teamid_switch) | Switch active team. |
| [`customgpt_post_api_teams_invitations`](#customgpt_post_api_teams_invitations) | Invite a new member. |
| [`customgpt_post_api_teams_invitations_by_invitationid_resend`](#customgpt_post_api_teams_invitations_by_invitationid_resend) | Resend an invitation. |
| [`customgpt_post_api_teams_roles`](#customgpt_post_api_teams_roles) | Create a custom role. |
| [`customgpt_post_api_user`](#customgpt_post_api_user) | Update user profile. |
| [`customgpt_put_api_projects_by_projectid_actions_builtin_by_actionkey_settings`](#customgpt_put_api_projects_by_projectid_actions_builtin_by_actionkey_settings) | Update built-in action settings. |
| [`customgpt_put_api_projects_by_projectid_actions_custom_by_actionkey`](#customgpt_put_api_projects_by_projectid_actions_custom_by_actionkey) | Update a custom action configuration. |
| [`customgpt_put_api_projects_by_projectid_conversations_by_sessionid`](#customgpt_put_api_projects_by_projectid_conversations_by_sessionid) | Update conversation. |
| [`customgpt_put_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_feedback`](#customgpt_put_api_projects_by_projectid_conversations_by_sessionid_messages_by_promptid_feedback) | Update message feedback. |
| [`customgpt_put_api_projects_by_projectid_labels`](#customgpt_put_api_projects_by_projectid_labels) | Assign users to a label. |
| [`customgpt_put_api_projects_by_projectid_labels_by_labelid`](#customgpt_put_api_projects_by_projectid_labels_by_labelid) | Update a label name. |
| [`customgpt_put_api_projects_by_projectid_licenses_by_licenseid`](#customgpt_put_api_projects_by_projectid_licenses_by_licenseid) | Update a license. |
| [`customgpt_put_api_projects_by_projectid_pages_by_pageid_labels`](#customgpt_put_api_projects_by_projectid_pages_by_pageid_labels) | Replace document labels. |
| [`customgpt_put_api_projects_by_projectid_pages_by_pageid_metadata`](#customgpt_put_api_projects_by_projectid_pages_by_pageid_metadata) | Update document metadata. |
| [`customgpt_put_api_projects_by_projectid_settings_persona_activate_by_version`](#customgpt_put_api_projects_by_projectid_settings_persona_activate_by_version) | Activate a persona version. |
| [`customgpt_put_api_projects_by_projectid_sources_by_sourceid`](#customgpt_put_api_projects_by_projectid_sources_by_sourceid) | Update source settings. |
| [`customgpt_put_api_projects_by_projectid_sources_by_sourceid_instant_sync`](#customgpt_put_api_projects_by_projectid_sources_by_sourceid_instant_sync) | Trigger instant source sync. |
| [`customgpt_put_api_projects_by_projectid_tasks_by_taskid`](#customgpt_put_api_projects_by_projectid_tasks_by_taskid) | Update task. |
| [`customgpt_put_api_teams`](#customgpt_put_api_teams) | Update a team name. |
| [`customgpt_put_api_teams_members_by_userid`](#customgpt_put_api_teams_members_by_userid) | Update a team member's role. |
| [`customgpt_put_api_teams_roles_by_roleid`](#customgpt_put_api_teams_roles_by_roleid) | Update a custom role. |
***
## 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). |
```json theme={null}
{
"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"). |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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 |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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\_settings\_persona\_by\_version\_sub\_personas\_by\_slug
Delete sub-persona override.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------- |
| `projectId` | integer | Yes | — | Project Id |
| `version` | integer | Yes | — | The version value |
| `slug` | string | Yes | — | The slug value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "Project Id"
},
"version": {
"type": "integer",
"description": "The version value"
},
"slug": {
"type": "string",
"description": "The slug value"
}
},
"required": [
"PCID",
"projectId",
"version",
"slug"
]
}
```
***
## 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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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 |
```json theme={null}
{
"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\_delete\_api\_teams\_invitations\_by\_invitationid
Cancel an invitation.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | --------------------------------- |
| `invitationId` | integer | Yes | — | The unique invitation identifier. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invitationId": {
"type": "integer",
"description": "The unique invitation identifier."
}
},
"required": [
"PCID",
"invitationId"
]
}
```
***
## customgpt\_delete\_api\_teams\_members\_by\_userid
Remove a team member.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------- |
| `userId` | integer | Yes | — | The user ID of the team member. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "integer",
"description": "The user ID of the team member."
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## customgpt\_get\_api\_billing\_invoices
List invoices.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number to retrieve. Starts at 1. Increment until the response's `last_page` value is reached. Default: 1. |
| `limit` | integer | No | — | Number of invoices to return per page. Default: 20. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number to retrieve. Starts at 1. Increment until the response's `last_page` value is reached. Default: 1."
},
"limit": {
"type": "integer",
"description": "Number of invoices to return per page. Default: 20."
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_get\_api\_billing\_invoices\_by\_invoiceid\_download
Download an invoice.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------- |
| `invoiceId` | integer | Yes | — | The local receipt ID for the invoice. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invoiceId": {
"type": "integer",
"description": "The local receipt ID for the invoice."
}
},
"required": [
"PCID",
"invoiceId"
]
}
```
***
## customgpt\_get\_api\_billing\_payment\_methods
List payment methods.
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_get\_api\_billing\_plan
Get current plan details.
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_get\_api\_limits\_usage
Get account limits.
```json theme={null}
{
"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 |
```json theme={null}
{
"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 |
```json theme={null}
{
"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%. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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\_deployment
Get deployment settings.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------------------------- |
| `projectId` | integer | Yes | — | The unique identifier of the agent. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique identifier of the agent."
}
},
"required": [
"PCID",
"projectId"
]
}
```
***
## 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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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). |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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) |
```json theme={null}
{
"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": [
-2,
-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. |
```json theme={null}
{
"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 |
```json theme={null}
{
"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). |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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). |
```json theme={null}
{
"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. |
```json theme={null}
{
"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\_persona\_by\_version\_sub\_personas
List sub-personas.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------- |
| `projectId` | integer | Yes | — | Project Id |
| `version` | integer | Yes | — | The version value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "Project Id"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"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. |
```json theme={null}
{
"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). |
```json theme={null}
{
"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). |
```json theme={null}
{
"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 |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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 |
```json theme={null}
{
"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 |
```json theme={null}
{
"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 |
```json theme={null}
{
"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 |
```json theme={null}
{
"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\_teams
List all teams the authenticated user belongs to.
**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. |
| `limit` | integer | No | — | Limit the number of results to return. Defaults to 20. |
```json theme={null}
{
"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."
},
"limit": {
"type": "integer",
"description": "Limit the number of results to return. Defaults to 20."
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_get\_api\_teams\_invitations
List pending invitations.
**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. |
| `limit` | integer | No | — | Limit the number of results to return. Defaults to 20. |
```json theme={null}
{
"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."
},
"limit": {
"type": "integer",
"description": "Limit the number of results to return. Defaults to 20."
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_get\_api\_teams\_members
List team members.
**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. |
| `limit` | integer | No | — | Limit the number of results to return. Defaults to 20. |
```json theme={null}
{
"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."
},
"limit": {
"type": "integer",
"description": "Limit the number of results to return. Defaults to 20."
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_get\_api\_teams\_roles
List roles.
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_get\_api\_user
Get current user profile.
```json theme={null}
{
"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 |
```json theme={null}
{
"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. |
```json theme={null}
{
"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\_patch\_api\_projects\_by\_projectid\_deployment\_by\_section
Update deployment settings.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `projectId` | integer | Yes | — | The unique agent identifier. |
| `section` | string | Yes | — | Deployment section to update. |
| `autoPopUp` | integer | No | — | Live chat auto-popup target. Accepted values: `0` (disabled), `1` (desktop), `2` (mobile), `3` (desktop and mobile). Applies to: `live_chat`. |
| `autoPromptStarterQuestion` | boolean | No | — | Automatically prompt the first starter question. Applies to: `live_chat`. |
| `autoStartConversation` | boolean | No | — | Automatically start a new conversation when the widget opens. Applies to: `live_chat`. |
| `chatbotType` | string | No | — | Visual style of the deployment widget. `live_chat` accepts `window`, `compact`, `floating`; `ai_assistant` and `instant_viewer` accept `window`, `compact`. Applies to: `live_chat`, `ai_assistant`, `instant_viewer`. |
| `continueConversation` | boolean | No | — | Persist and continue the previous conversation. Applies to: `live_chat`. |
| `customSearchParameter` | string | No | — | URL query parameter name to pass as the search query. Alphanumeric, dash, underscore; max 15 characters. Applies to: `sge`. |
| `defaultButtonColor` | string | No | — | Hex color for the default trigger button. Accepted formats: `#FFF`, `#FFFFFF`, or `#FFFFFFFF`. Applies to: `ai_assistant`, `instant_viewer`. |
| `defaultButtonText` | string | No | — | Label text on the default trigger button. Applies to: `ai_assistant`, `instant_viewer`. |
| `delayIframeLoadMs` | number | No | — | Milliseconds to delay iframe load. Applies to: `embed`, `sge`. |
| `doNotPromptOnMobile` | boolean | No | — | Suppress auto-prompts on mobile devices. Applies to: `live_chat`. |
| `height` | number | No | — | Widget height value. Applies to: `embed`, `live_chat`, `sge`. |
| `heightType` | string | No | — | Whether height is fixed or automatic. Applies to: `embed`, `live_chat`, `sge`. |
| `heightUnit` | string | No | — | Unit for height. Applies to: `embed`, `live_chat`, `sge`. |
| `hidePromptFromStarterQuestionList` | boolean | No | — | Hide the pre-prompt from the starter question list. Applies to: `live_chat`. |
| `iconSize` | string | No | — | Icon size for the live chat bubble trigger. Applies to: `live_chat`. |
| `isCRMIntegrationEnabled` | boolean | No | — | Whether CRM integration is enabled for this deployment. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`. |
| `isCustomContextEnabled` | boolean | No | — | Whether custom context injection is enabled. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`. |
| `isLabelsFilterEnabled` | boolean | No | — | Filter responses by source labels. Requires a plan with source labeling. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`. |
| `isPrePromptEnabled` | boolean | No | — | Whether the pre-prompt is enabled for this deployment. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`. |
| `isUsingCustomElement` | boolean | No | — | Whether a custom HTML element is used as the trigger. Applies to: `ai_assistant`, `instant_viewer`. |
| `isUsingDefaultButton` | boolean | No | — | Whether to show the default styled button. Applies to: `ai_assistant`, `instant_viewer`. |
| `labelsExclusive` | boolean | No | — | When label filtering is active, use exclusive AND matching. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`. |
| `mobileFontSize` | boolean | No | — | Use mobile-optimized font sizing. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`. |
| `position` | string | No | — | Screen position of the live chat bubble. Applies to: `live_chat`. |
| `resetConversation` | boolean | No | — | Reset the conversation on each new session. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`. |
| `width` | number | No | — | Widget width value. Applies to: `embed`, `live_chat`. |
| `widthUnit` | string | No | — | Unit for width. Applies to: `embed`, `live_chat`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The unique agent identifier."
},
"section": {
"type": "string",
"description": "Deployment section to update.",
"enum": [
"embed",
"live_chat",
"ai_assistant",
"instant_viewer",
"sge"
]
},
"autoPopUp": {
"type": "integer",
"description": "Live chat auto-popup target. Accepted values: `0` (disabled), `1` (desktop), `2` (mobile), `3` (desktop and mobile). Applies to: `live_chat`.",
"enum": [
0,
1,
2,
3
]
},
"autoPromptStarterQuestion": {
"type": "boolean",
"description": "Automatically prompt the first starter question. Applies to: `live_chat`."
},
"autoStartConversation": {
"type": "boolean",
"description": "Automatically start a new conversation when the widget opens. Applies to: `live_chat`."
},
"chatbotType": {
"type": "string",
"description": "Visual style of the deployment widget. `live_chat` accepts `window`, `compact`, `floating`; `ai_assistant` and `instant_viewer` accept `window`, `compact`. Applies to: `live_chat`, `ai_assistant`, `instant_viewer`.",
"enum": [
"window",
"compact",
"floating"
]
},
"continueConversation": {
"type": "boolean",
"description": "Persist and continue the previous conversation. Applies to: `live_chat`."
},
"customSearchParameter": {
"type": "string",
"description": "URL query parameter name to pass as the search query. Alphanumeric, dash, underscore; max 15 characters. Applies to: `sge`."
},
"defaultButtonColor": {
"type": "string",
"description": "Hex color for the default trigger button. Accepted formats: `#FFF`, `#FFFFFF`, or `#FFFFFFFF`. Applies to: `ai_assistant`, `instant_viewer`."
},
"defaultButtonText": {
"type": "string",
"description": "Label text on the default trigger button. Applies to: `ai_assistant`, `instant_viewer`."
},
"delayIframeLoadMs": {
"type": "number",
"description": "Milliseconds to delay iframe load. Applies to: `embed`, `sge`."
},
"doNotPromptOnMobile": {
"type": "boolean",
"description": "Suppress auto-prompts on mobile devices. Applies to: `live_chat`."
},
"height": {
"type": "number",
"description": "Widget height value. Applies to: `embed`, `live_chat`, `sge`."
},
"heightType": {
"type": "string",
"description": "Whether height is fixed or automatic. Applies to: `embed`, `live_chat`, `sge`.",
"enum": [
"fixed",
"auto"
]
},
"heightUnit": {
"type": "string",
"description": "Unit for height. Applies to: `embed`, `live_chat`, `sge`.",
"enum": [
"px",
"%"
]
},
"hidePromptFromStarterQuestionList": {
"type": "boolean",
"description": "Hide the pre-prompt from the starter question list. Applies to: `live_chat`."
},
"iconSize": {
"type": "string",
"description": "Icon size for the live chat bubble trigger. Applies to: `live_chat`.",
"enum": [
"small",
"medium",
"large"
]
},
"isCRMIntegrationEnabled": {
"type": "boolean",
"description": "Whether CRM integration is enabled for this deployment. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`."
},
"isCustomContextEnabled": {
"type": "boolean",
"description": "Whether custom context injection is enabled. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`."
},
"isLabelsFilterEnabled": {
"type": "boolean",
"description": "Filter responses by source labels. Requires a plan with source labeling. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`."
},
"isPrePromptEnabled": {
"type": "boolean",
"description": "Whether the pre-prompt is enabled for this deployment. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`."
},
"isUsingCustomElement": {
"type": "boolean",
"description": "Whether a custom HTML element is used as the trigger. Applies to: `ai_assistant`, `instant_viewer`."
},
"isUsingDefaultButton": {
"type": "boolean",
"description": "Whether to show the default styled button. Applies to: `ai_assistant`, `instant_viewer`."
},
"labelsExclusive": {
"type": "boolean",
"description": "When label filtering is active, use exclusive AND matching. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`."
},
"mobileFontSize": {
"type": "boolean",
"description": "Use mobile-optimized font sizing. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`, `sge`."
},
"position": {
"type": "string",
"description": "Screen position of the live chat bubble. Applies to: `live_chat`.",
"enum": [
"right",
"left"
]
},
"resetConversation": {
"type": "boolean",
"description": "Reset the conversation on each new session. Applies to: `embed`, `live_chat`, `ai_assistant`, `instant_viewer`."
},
"width": {
"type": "number",
"description": "Widget width value. Applies to: `embed`, `live_chat`."
},
"widthUnit": {
"type": "string",
"description": "Unit for width. Applies to: `embed`, `live_chat`.",
"enum": [
"px",
"%"
]
}
},
"required": [
"PCID",
"projectId",
"section"
]
}
```
***
## customgpt\_patch\_api\_projects\_by\_projectid\_settings\_persona\_by\_version\_sub\_personas\_by\_slug
Update sub-persona override.
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------- | ------- | -------- | ------- | ----------------- | ------------------------------------------------------------------------------------------------------------ |
| `projectId` | integer | Yes | — | Project Id | |
| `version` | integer | Yes | — | The version value | |
| `slug` | string | Yes | — | The slug value | |
| `instructions` | string | null | No | — | Override instructions. Empty strings are saved as blank overrides. Use DELETE to clear the project override. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "Project Id"
},
"version": {
"type": "integer",
"description": "The version value"
},
"slug": {
"type": "string",
"description": "The slug value"
},
"instructions": {
"type": [
"string",
"null"
],
"description": "Override instructions. Empty strings are saved as blank overrides. Use DELETE to clear the project override."
}
},
"required": [
"PCID",
"projectId",
"version",
"slug"
]
}
```
***
## customgpt\_post\_api\_projects
Create an agent.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `allow_extra_timeout` | boolean | No | — | Allow extra processing time when crawling slow or large sources. |
| `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. |
| `image_extraction_type` | string | No | — | The method used for extracting images from the website. |
| `is_anonymized` | boolean | No | — | Anonymized |
| `is_low_performance_mode_enabled` | boolean | No | — | Use a lower-performance crawl mode that is less likely to be blocked by websites with aggressive bot protection. |
| `is_master` | boolean | No | — | Whether this agent is a master agent. Can only be set at creation time — cannot be changed afterwards. |
| `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 | — | Supports YouTube, Vimeo, sitemaps, and websites. |
| `use_full_url_crawl` | boolean | No | — | Crawl every URL discovered on the site rather than relying solely on the sitemap. |
| `use_planner_mode` | boolean | No | — | Whether to enable Plan & Act mode for this agent. Defaults to false. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"allow_extra_timeout": {
"type": "boolean",
"description": "Allow extra processing time when crawling slow or large sources."
},
"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."
},
"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_low_performance_mode_enabled": {
"type": "boolean",
"description": "Use a lower-performance crawl mode that is less likely to be blocked by websites with aggressive bot protection."
},
"is_master": {
"type": "boolean",
"description": "Whether this agent is a master agent. Can only be set at creation time — cannot be changed afterwards."
},
"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": "Supports YouTube, Vimeo, sitemaps, and websites."
},
"use_full_url_crawl": {
"type": "boolean",
"description": "Crawl every URL discovered on the site rather than relying solely on the sitemap."
},
"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). |
| `allow_extra_timeout` | boolean | No | — | Allow extra processing time when crawling slow or large sources. |
| `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. |
| `image_extraction_type` | string | No | — | The method used for extracting images from the website. |
| `is_anonymized` | boolean | No | — | Anonymized |
| `is_low_performance_mode_enabled` | boolean | No | — | Use a lower-performance crawl mode that is less likely to be blocked by websites with aggressive bot protection. |
| `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 | — | Supports YouTube, Vimeo, sitemaps, and websites. |
| `use_full_url_crawl` | boolean | No | — | Crawl every URL discovered on the site rather than relying solely on the sitemap. |
```json theme={null}
{
"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)."
},
"allow_extra_timeout": {
"type": "boolean",
"description": "Allow extra processing time when crawling slow or large sources."
},
"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."
},
"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_low_performance_mode_enabled": {
"type": "boolean",
"description": "Use a lower-performance crawl mode that is less likely to be blocked by websites with aggressive bot protection."
},
"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": "Supports YouTube, Vimeo, sitemaps, and websites."
},
"use_full_url_crawl": {
"type": "boolean",
"description": "Crawl every URL discovered on the site rather than relying solely on the sitemap."
}
},
"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 | null | No | — | Action description. |
| `name` | string | No | — | Action name. | |
| `settings` | object | No | — | Custom action settings. | |
```json theme={null}
{
"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",
"null"
],
"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 | null | 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 | null | No | — | ID of the model to use |
| `stream` | boolean | No | — | Whether to stream the response | |
| `sub_personas` | object | No | — | Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value. | |
```json theme={null}
{
"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",
"null"
],
"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",
"null"
],
"description": "ID of the model to use"
},
"stream": {
"type": "boolean",
"description": "Whether to stream the response"
},
"sub_personas": {
"type": "object",
"description": "Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value.",
"properties": {
"persona-summary": {
"type": "string",
"description": "The persona-summary value"
},
"task-planner": {
"type": "string",
"description": "The task-planner value"
}
}
}
},
"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. |
```json theme={null}
{
"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 |
```json theme={null}
{
"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 | null | 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 | null | No | — | Agent model to use for the conversation |
| `custom_context` | string | null | No | — | Custom context to use for the conversation |
| `custom_persona` | string | null | No | — | Custom persona to use for the conversation |
| `file` | string | null | 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 | null | 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. |
| `sub_personas` | object | No | — | Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value. For multipart/form-data, send bracket notation like sub\_personas\[persona-summary]=... | |
```json theme={null}
{
"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",
"null"
],
"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",
"null"
],
"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",
"null"
],
"description": "Custom context to use for the conversation"
},
"custom_persona": {
"type": [
"string",
"null"
],
"description": "Custom persona to use for the conversation"
},
"file": {
"type": [
"string",
"null"
],
"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",
"null"
],
"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"
]
},
"sub_personas": {
"type": "object",
"description": "Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value. For multipart/form-data, send bracket notation like sub_personas[persona-summary]=...",
"properties": {
"persona-summary": {
"type": "string",
"description": "The persona-summary value"
},
"task-planner": {
"type": "string",
"description": "The task-planner value"
}
}
}
},
"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. |
```json theme={null}
{
"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) |
```json theme={null}
{
"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 |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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 |
```json theme={null}
{
"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). |
| `allow_extra_timeout` | boolean | No | — | Allow extra processing time when crawling slow or large sources. |
| `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_low_performance_mode_enabled` | boolean | No | — | Use a lower-performance crawl mode that is less likely to be blocked by websites with aggressive bot protection. |
| `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 | — | Supports YouTube, Vimeo, sitemaps, and websites. |
| `use_full_url_crawl` | boolean | No | — | Crawl every URL discovered on the site rather than relying solely on the sitemap. |
```json theme={null}
{
"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)."
},
"allow_extra_timeout": {
"type": "boolean",
"description": "Allow extra processing time when crawling slow or large sources."
},
"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_low_performance_mode_enabled": {
"type": "boolean",
"description": "Use a lower-performance crawl mode that is less likely to be blocked by websites with aggressive bot protection."
},
"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": "Supports YouTube, Vimeo, sitemaps, and websites."
},
"use_full_url_crawl": {
"type": "boolean",
"description": "Crawl every URL discovered on the site rather than relying solely on the sitemap."
}
},
"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 | null | 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 | null | No | — | Agent model to use for the conversation |
| `custom_context` | string | null | No | — | Custom context to use for the conversation |
| `custom_persona` | string | null | No | — | Custom persona to use for the conversation |
| `file` | string | null | 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 | null | 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 | null | 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. |
| `sub_personas` | object | No | — | Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value. For multipart/form-data, send bracket notation like sub\_personas\[persona-summary]=... | |
| `tools` | object\[] | No | — | Functions the agent may call during this task (OpenAI tools format, max 10). When the agent decides to call one, polling returns `status: awaiting_tool_results` with `result.tool_calls`; execute the functions and submit results via `POST /tasks/{taskId}/tool-outputs`. On multipart requests, pass this field as a JSON-encoded string. | |
```json theme={null}
{
"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",
"null"
],
"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",
"null"
],
"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",
"null"
],
"description": "Custom context to use for the conversation"
},
"custom_persona": {
"type": [
"string",
"null"
],
"description": "Custom persona to use for the conversation"
},
"file": {
"type": [
"string",
"null"
],
"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",
"null"
],
"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",
"null"
],
"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"
]
},
"sub_personas": {
"type": "object",
"description": "Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value. For multipart/form-data, send bracket notation like sub_personas[persona-summary]=...",
"properties": {
"persona-summary": {
"type": "string",
"description": "The persona-summary value"
},
"task-planner": {
"type": "string",
"description": "The task-planner value"
}
}
},
"tools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"function"
],
"description": "The type value"
},
"function": {
"type": "object",
"description": "The function value"
}
},
"required": [
"type",
"function"
]
},
"description": "Functions the agent may call during this task (OpenAI tools format, max 10). When the agent decides to call one, polling returns `status: awaiting_tool_results` with `result.tool_calls`; execute the functions and submit results via `POST /tasks/{taskId}/tool-outputs`. On multipart requests, pass this field as a JSON-encoded string."
}
},
"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 | null | No | — | Agent model to use for the task |
| `custom_context` | string | null | No | — | Custom context to use for the task |
| `custom_persona` | string | null | 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 | null | 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. |
| `sub_personas` | object | No | — | Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value. On multipart requests, pass bracket notation like sub\_personas\[persona-summary]=... | |
| `tools` | object\[] | No | — | Functions the agent may call during this task (OpenAI tools format, max 10). When the agent decides to call one, polling returns `status: awaiting_tool_results` with `result.tool_calls`; execute the functions and submit results via `POST /tasks/{taskId}/tool-outputs`. On multipart requests, pass this field as a JSON-encoded string. | |
```json theme={null}
{
"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",
"null"
],
"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",
"null"
],
"description": "Custom context to use for the task"
},
"custom_persona": {
"type": [
"string",
"null"
],
"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",
"null"
],
"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"
]
},
"sub_personas": {
"type": "object",
"description": "Request-only sub-persona overrides keyed by sub-persona slug. Omitted keys use the saved generated/project value. On multipart requests, pass bracket notation like sub_personas[persona-summary]=...",
"properties": {
"persona-summary": {
"type": "string",
"description": "The persona-summary value"
},
"task-planner": {
"type": "string",
"description": "The task-planner value"
}
}
},
"tools": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"function"
],
"description": "The type value"
},
"function": {
"type": "object",
"description": "The function value"
}
},
"required": [
"type",
"function"
]
},
"description": "Functions the agent may call during this task (OpenAI tools format, max 10). When the agent decides to call one, polling returns `status: awaiting_tool_results` with `result.tool_calls`; execute the functions and submit results via `POST /tasks/{taskId}/tool-outputs`. On multipart requests, pass this field as a JSON-encoded string."
}
},
"required": [
"PCID",
"projectId",
"taskId",
"prompt"
]
}
```
***
## customgpt\_post\_api\_projects\_by\_projectid\_tasks\_by\_taskid\_tool\_outputs
Submit tool outputs.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ----------------------------------- |
| `projectId` | integer | Yes | — | The unique identifier of the agent. |
| `taskId` | string | Yes | — | The task ID. |
| `tool_outputs` | object\[] | Yes | — | One entry per pending tool call. |
```json theme={null}
{
"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."
},
"tool_outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tool_call_id": {
"type": "string",
"description": "The `id` of the tool call being answered, as returned in `result.tool_calls`."
},
"output": {
"type": "string",
"description": "The function result, serialized as a string (typically JSON)."
}
},
"required": [
"tool_call_id",
"output"
]
},
"description": "One entry per pending tool call."
}
},
"required": [
"PCID",
"projectId",
"taskId",
"tool_outputs"
]
}
```
***
## customgpt\_post\_api\_teams\_by\_teamid\_switch
Switch active team.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------- |
| `teamId` | integer | Yes | — | The unique team identifier. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "integer",
"description": "The unique team identifier."
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## customgpt\_post\_api\_teams\_invitations
Invite a new member.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `email` | string | No | — | Email address of the person to invite |
| `role_id` | integer | No | — | Role ID to assign to the invited member |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "Email address of the person to invite"
},
"role_id": {
"type": "integer",
"description": "Role ID to assign to the invited member"
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_post\_api\_teams\_invitations\_by\_invitationid\_resend
Resend an invitation.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | --------------------------------- |
| `invitationId` | integer | Yes | — | The unique invitation identifier. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invitationId": {
"type": "integer",
"description": "The unique invitation identifier."
}
},
"required": [
"PCID",
"invitationId"
]
}
```
***
## customgpt\_post\_api\_teams\_roles
Create a custom role.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ---------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `agents` | integer\[] | No | — | Agent IDs this role grants access to. Required when type is local. |
| `allow_create_agents` | boolean | No | — | Whether members with this role can create new agents. |
| `description` | string | No | — | Description of the role. Max 255 characters. |
| `is_chat_only` | boolean | No | — | When true, members with this role can only use chat. The permissions field is ignored and set automatically. |
| `name` | string | No | — | Role name. Cannot match a reserved system role name. Max 255 characters. |
| `permissions` | string\[] | No | — | Permission names to grant to this role. Ignored when is\_chat\_only is true. Omit or pass an empty array for no permissions. |
| `type` | string | No | — | Role scope. Use local to restrict access to specific agents; use global to grant access to all team agents. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agents": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Agent IDs this role grants access to. Required when type is local."
},
"allow_create_agents": {
"type": "boolean",
"description": "Whether members with this role can create new agents."
},
"description": {
"type": "string",
"description": "Description of the role. Max 255 characters."
},
"is_chat_only": {
"type": "boolean",
"description": "When true, members with this role can only use chat. The permissions field is ignored and set automatically."
},
"name": {
"type": "string",
"description": "Role name. Cannot match a reserved system role name. Max 255 characters."
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Add team member",
"Remove team member",
"Update team name",
"Create Project",
"Delete Project",
"View Project Stats",
"View Project Logs",
"Read Project Settings",
"Update Project Settings",
"View Project Source",
"Create Project Source",
"Update Project Source",
"Delete Project Source",
"View Subscription",
"Create Conversation",
"Delete Team Conversations",
"Delete Anonymous Conversations",
"Update Team Conversations",
"Update Anonymous Conversations",
"Read Team Conversations",
"Read Anonymous Conversations",
"Export Conversation"
]
},
"description": "Permission names to grant to this role. Ignored when is_chat_only is true. Omit or pass an empty array for no permissions."
},
"type": {
"type": "string",
"description": "Role scope. Use local to restrict access to specific agents; use global to grant access to all team agents.",
"enum": [
"local",
"global"
]
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_post\_api\_user
Update user profile.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------ |
| `body` | object | No | — | Update user account info |
```json theme={null}
{
"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. |
```json theme={null}
{
"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 | null | No | — | Custom action type. |
| `description` | string | null | No | — | Custom action description. |
| `is_enabled` | boolean | null | No | — | Whether the custom action is enabled. |
| `name` | string | null | No | — | Custom action name. |
| `settings` | object | No | — | Custom MCP settings. | |
```json theme={null}
{
"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",
"null"
],
"description": "Custom action type.",
"enum": [
"mcp_connector"
]
},
"description": {
"type": [
"string",
"null"
],
"description": "Custom action description."
},
"is_enabled": {
"type": [
"boolean",
"null"
],
"description": "Whether the custom action is enabled."
},
"name": {
"type": [
"string",
"null"
],
"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 |
```json theme={null}
{
"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 |
```json theme={null}
{
"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 |
```json theme={null}
{
"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) |
```json theme={null}
{
"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 |
```json theme={null}
{
"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) |
```json theme={null}
{
"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 | null | No | — | The description of the document used in citations |
| `image` | string | null | No | — | The url of the image used in citations |
| `title` | string | null | No | — | The title of the document used in citations |
| `url` | string | null | No | — | The url of the document used in citations |
```json theme={null}
{
"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",
"null"
],
"description": "The description of the document used in citations"
},
"image": {
"type": [
"string",
"null"
],
"description": "The url of the image used in citations"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the document used in citations"
},
"url": {
"type": [
"string",
"null"
],
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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. |
```json theme={null}
{
"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"
]
}
```
***
## customgpt\_put\_api\_teams
Update a team name.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------- |
| `team_name` | string | No | — | New team name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"team_name": {
"type": "string",
"description": "New team name"
}
},
"required": [
"PCID"
]
}
```
***
## customgpt\_put\_api\_teams\_members\_by\_userid
Update a team member's role.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------- |
| `userId` | integer | Yes | — | The user ID of the team member. |
| `role_id` | integer | No | — | Role ID to assign to the member |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "integer",
"description": "The user ID of the team member."
},
"role_id": {
"type": "integer",
"description": "Role ID to assign to the member"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## customgpt\_put\_api\_teams\_roles\_by\_roleid
Update a custom role.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ---------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `roleId` | integer | Yes | — | The unique role identifier. |
| `agents` | integer\[] | No | — | Agent IDs this role grants access to. Required when type is local. |
| `allow_create_agents` | boolean | No | — | Whether members with this role can create new agents. |
| `description` | string | No | — | Description of the role. Max 255 characters. |
| `is_chat_only` | boolean | No | — | When true, members with this role can only use chat. The permissions field is ignored and set automatically. |
| `name` | string | No | — | Role name. Cannot match a reserved system role name. Max 255 characters. |
| `permissions` | string\[] | No | — | Permission names to grant to this role. Ignored when is\_chat\_only is true. Omit or pass an empty array for no permissions. |
| `type` | string | No | — | Role scope. Use local to restrict access to specific agents; use global to grant access to all team agents. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roleId": {
"type": "integer",
"description": "The unique role identifier."
},
"agents": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Agent IDs this role grants access to. Required when type is local."
},
"allow_create_agents": {
"type": "boolean",
"description": "Whether members with this role can create new agents."
},
"description": {
"type": "string",
"description": "Description of the role. Max 255 characters."
},
"is_chat_only": {
"type": "boolean",
"description": "When true, members with this role can only use chat. The permissions field is ignored and set automatically."
},
"name": {
"type": "string",
"description": "Role name. Cannot match a reserved system role name. Max 255 characters."
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Add team member",
"Remove team member",
"Update team name",
"Create Project",
"Delete Project",
"View Project Stats",
"View Project Logs",
"Read Project Settings",
"Update Project Settings",
"View Project Source",
"Create Project Source",
"Update Project Source",
"Delete Project Source",
"View Subscription",
"Create Conversation",
"Delete Team Conversations",
"Delete Anonymous Conversations",
"Update Team Conversations",
"Update Anonymous Conversations",
"Read Team Conversations",
"Read Anonymous Conversations",
"Export Conversation"
]
},
"description": "Permission names to grant to this role. Ignored when is_chat_only is true. Omit or pass an empty array for no permissions."
},
"type": {
"type": "string",
"description": "Role scope. Use local to restrict access to specific agents; use global to grant access to all team agents.",
"enum": [
"local",
"global"
]
}
},
"required": [
"PCID",
"roleId"
]
}
```