> ## 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.

# genesys-ai-studio

> Genesys AI Studio - virtual agents, guides, and conversation summary settings

**Server path:** `/genesys-ai-studio` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                    | Description                                                           |
| ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| [`genesys-ai-studio_delete_conversations_summaries_setting`](#genesys-ai-studio_delete_conversations_summaries_setting) | Delete a summary setting.                                             |
| [`genesys-ai-studio_delete_guide_jobs`](#genesys-ai-studio_delete_guide_jobs)                                           | Start the deletion of a guide.                                        |
| [`genesys-ai-studio_delete_virtualagent_jobs`](#genesys-ai-studio_delete_virtualagent_jobs)                             | Start the deletion of a virtualAgent.                                 |
| [`genesys-ai-studio_get_conversations_summaries_setting`](#genesys-ai-studio_get_conversations_summaries_setting)       | Receive a summary setting.                                            |
| [`genesys-ai-studio_get_conversations_summaries_settings`](#genesys-ai-studio_get_conversations_summaries_settings)     | Get all summary settings.                                             |
| [`genesys-ai-studio_get_guide`](#genesys-ai-studio_get_guide)                                                           | Get guide.                                                            |
| [`genesys-ai-studio_get_guide_job`](#genesys-ai-studio_get_guide_job)                                                   | Get the specified guide deletion job.                                 |
| [`genesys-ai-studio_get_guide_version`](#genesys-ai-studio_get_guide_version)                                           | Get a guide version.                                                  |
| [`genesys-ai-studio_get_guide_version_job`](#genesys-ai-studio_get_guide_version_job)                                   | Get the status of the publishing job for this guide version.          |
| [`genesys-ai-studio_get_guides`](#genesys-ai-studio_get_guides)                                                         | Get all guides.                                                       |
| [`genesys-ai-studio_get_guides_job`](#genesys-ai-studio_get_guides_job)                                                 | Get the status of the guide content generation job.                   |
| [`genesys-ai-studio_get_virtualagent`](#genesys-ai-studio_get_virtualagent)                                             | Get virtual agent.                                                    |
| [`genesys-ai-studio_get_virtualagent_job`](#genesys-ai-studio_get_virtualagent_job)                                     | Get a virtualAgent job.                                               |
| [`genesys-ai-studio_get_virtualagent_version`](#genesys-ai-studio_get_virtualagent_version)                             | Get a virtual agent version.                                          |
| [`genesys-ai-studio_get_virtualagent_version_job`](#genesys-ai-studio_get_virtualagent_version_job)                     | Get the status of the publishing job for this virtual agent version.  |
| [`genesys-ai-studio_get_virtualagents`](#genesys-ai-studio_get_virtualagents)                                           | Get all virtual agents.                                               |
| [`genesys-ai-studio_patch_guide`](#genesys-ai-studio_patch_guide)                                                       | Update a guide.                                                       |
| [`genesys-ai-studio_patch_guide_version`](#genesys-ai-studio_patch_guide_version)                                       | Update a guide version.                                               |
| [`genesys-ai-studio_patch_virtualagent`](#genesys-ai-studio_patch_virtualagent)                                         | Update a virtual agent.                                               |
| [`genesys-ai-studio_patch_virtualagent_version`](#genesys-ai-studio_patch_virtualagent_version)                         | Update a virtual agent version.                                       |
| [`genesys-ai-studio_post_conversations_summaries_preview`](#genesys-ai-studio_post_conversations_summaries_preview)     | Trigger summary preview event generation.                             |
| [`genesys-ai-studio_post_conversations_summaries_settings`](#genesys-ai-studio_post_conversations_summaries_settings)   | Create a summary setting.                                             |
| [`genesys-ai-studio_post_guide_session_turns`](#genesys-ai-studio_post_guide_session_turns)                             | Add a turn to a guide session.                                        |
| [`genesys-ai-studio_post_guide_version_jobs`](#genesys-ai-studio_post_guide_version_jobs)                               | Start the publishing of a guide version.                              |
| [`genesys-ai-studio_post_guide_versions`](#genesys-ai-studio_post_guide_versions)                                       | Create a guide version.                                               |
| [`genesys-ai-studio_post_guides`](#genesys-ai-studio_post_guides)                                                       | Create a guide.                                                       |
| [`genesys-ai-studio_post_guides_jobs`](#genesys-ai-studio_post_guides_jobs)                                             | Start a guide content generation job.                                 |
| [`genesys-ai-studio_post_guides_uploads`](#genesys-ai-studio_post_guides_uploads)                                       | Generate presigned URL for uploading a file content to generate guide |
| [`genesys-ai-studio_post_virtualagent_version_jobs`](#genesys-ai-studio_post_virtualagent_version_jobs)                 | Start the publishing of a virtual agent version.                      |
| [`genesys-ai-studio_post_virtualagent_versions`](#genesys-ai-studio_post_virtualagent_versions)                         | Create a virtual agent version.                                       |
| [`genesys-ai-studio_post_virtualagents`](#genesys-ai-studio_post_virtualagents)                                         | Create a virtual agent.                                               |
| [`genesys-ai-studio_put_conversations_summaries_setting`](#genesys-ai-studio_put_conversations_summaries_setting)       | Update a summary setting.                                             |

***

## genesys-ai-studio\_delete\_conversations\_summaries\_setting

Delete a summary setting.

**Parameters:**

| Parameter          | Type   | Required | Default | Description        |
| ------------------ | ------ | -------- | ------- | ------------------ |
| `summarySettingId` | string | Yes      | —       | Summary setting id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "summarySettingId": {
        "type": "string",
        "description": "Summary setting id"
      }
    },
    "required": [
      "PCID",
      "summarySettingId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_delete\_guide\_jobs

Start the deletion of a guide.

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `guideId` | string | Yes      | —       | Guide ID    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      }
    },
    "required": [
      "PCID",
      "guideId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_delete\_virtualagent\_jobs

Start the deletion of a virtualAgent.

**Parameters:**

| Parameter        | Type   | Required | Default | Description      |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      }
    },
    "required": [
      "PCID",
      "virtualAgentId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_conversations\_summaries\_setting

Receive a summary setting.

**Parameters:**

| Parameter          | Type   | Required | Default | Description        |
| ------------------ | ------ | -------- | ------- | ------------------ |
| `summarySettingId` | string | Yes      | —       | Summary setting id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "summarySettingId": {
        "type": "string",
        "description": "Summary setting id"
      }
    },
    "required": [
      "PCID",
      "summarySettingId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_conversations\_summaries\_settings

Get all summary settings.

**Parameters:**

| Parameter    | Type    | Required | Default | Description                                           |
| ------------ | ------- | -------- | ------- | ----------------------------------------------------- |
| `pageNumber` | integer | No       | —       | Page number.                                          |
| `pageSize`   | integer | No       | —       | Page size. The maximum page size is 100.              |
| `name`       | string  | No       | —       | Filter by partially matching name - case insensitive. |
| `sortOrder`  | string  | No       | —       | Sort Order. Default value desc.                       |
| `language`   | string  | No       | —       | Filter by matching language - case insensitive.       |
| `sortBy`     | string  | No       | —       | Sort by. Default value dateModified.                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "pageNumber": {
        "type": "integer",
        "description": "Page number."
      },
      "pageSize": {
        "type": "integer",
        "description": "Page size. The maximum page size is 100."
      },
      "name": {
        "type": "string",
        "description": "Filter by partially matching name - case insensitive."
      },
      "sortOrder": {
        "type": "string",
        "description": "Sort Order. Default value desc.",
        "enum": [
          "asc",
          "desc"
        ]
      },
      "language": {
        "type": "string",
        "description": "Filter by matching language - case insensitive."
      },
      "sortBy": {
        "type": "string",
        "description": "Sort by. Default value dateModified.",
        "enum": [
          "dateModified",
          "name"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_guide

Get guide.

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `guideId` | string | Yes      | —       | Guide ID    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      }
    },
    "required": [
      "PCID",
      "guideId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_guide\_job

Get the specified guide deletion job.

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `guideId` | string | Yes      | —       | Guide ID    |
| `jobId`   | string | Yes      | —       | Job Id      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "jobId": {
        "type": "string",
        "description": "Job Id"
      }
    },
    "required": [
      "PCID",
      "guideId",
      "jobId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_guide\_version

Get a guide version.

**Parameters:**

| Parameter   | Type   | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `guideId`   | string | Yes      | —       | Guide ID    |
| `versionId` | string | Yes      | —       | Version ID  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      }
    },
    "required": [
      "PCID",
      "guideId",
      "versionId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_guide\_version\_job

Get the status of the publishing job for this guide version.

**Parameters:**

| Parameter   | Type   | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `guideId`   | string | Yes      | —       | Guide ID    |
| `versionId` | string | Yes      | —       | Version ID  |
| `jobId`     | string | Yes      | —       | Job Id      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      },
      "jobId": {
        "type": "string",
        "description": "Job Id"
      }
    },
    "required": [
      "PCID",
      "guideId",
      "versionId",
      "jobId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_guides

Get all guides.

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                 |
| -------------- | ------- | -------- | ------- | ------------------------------------------- |
| `name`         | string  | No       | —       | Filter by matching name - case insensitive. |
| `nameContains` | string  | No       | —       | Filter by name contains - case insensitive. |
| `status`       | string  | No       | —       | Filter by status.                           |
| `sortBy`       | string  | No       | —       | Sort by. Default value dateModified.        |
| `sortOrder`    | string  | No       | —       | Sort Order. Default value desc.             |
| `pageNumber`   | integer | No       | —       | Page number.                                |
| `pageSize`     | integer | No       | —       | Page size. The maximum page size is 100.    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Filter by matching name - case insensitive."
      },
      "nameContains": {
        "type": "string",
        "description": "Filter by name contains - case insensitive."
      },
      "status": {
        "type": "string",
        "description": "Filter by status.",
        "enum": [
          "Published",
          "Draft"
        ]
      },
      "sortBy": {
        "type": "string",
        "description": "Sort by. Default value dateModified.",
        "enum": [
          "dateModified",
          "name",
          "status"
        ]
      },
      "sortOrder": {
        "type": "string",
        "description": "Sort Order. Default value desc.",
        "enum": [
          "asc",
          "desc"
        ]
      },
      "pageNumber": {
        "type": "integer",
        "description": "Page number."
      },
      "pageSize": {
        "type": "integer",
        "description": "Page size. The maximum page size is 100."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_guides\_job

Get the status of the guide content generation job.

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `jobId`   | string | Yes      | —       | Job Id      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "jobId": {
        "type": "string",
        "description": "Job Id"
      }
    },
    "required": [
      "PCID",
      "jobId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_virtualagent

Get virtual agent.

**Parameters:**

| Parameter        | Type   | Required | Default | Description      |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      }
    },
    "required": [
      "PCID",
      "virtualAgentId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_virtualagent\_job

Get a virtualAgent job.

**Parameters:**

| Parameter        | Type   | Required | Default | Description      |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID |
| `jobId`          | string | Yes      | —       | Job Id           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      },
      "jobId": {
        "type": "string",
        "description": "Job Id"
      }
    },
    "required": [
      "PCID",
      "virtualAgentId",
      "jobId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_virtualagent\_version

Get a virtual agent version.

**Parameters:**

| Parameter        | Type   | Required | Default | Description      |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID |
| `versionId`      | string | Yes      | —       | Version ID       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      }
    },
    "required": [
      "PCID",
      "virtualAgentId",
      "versionId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_virtualagent\_version\_job

Get the status of the publishing job for this virtual agent version.

**Parameters:**

| Parameter        | Type   | Required | Default | Description      |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID |
| `versionId`      | string | Yes      | —       | Version ID       |
| `jobId`          | string | Yes      | —       | Job Id           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      },
      "jobId": {
        "type": "string",
        "description": "Job Id"
      }
    },
    "required": [
      "PCID",
      "virtualAgentId",
      "versionId",
      "jobId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_get\_virtualagents

Get all virtual agents.

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                 |
| -------------- | ------- | -------- | ------- | ------------------------------------------- |
| `name`         | string  | No       | —       | Filter by matching name - case insensitive. |
| `nameContains` | string  | No       | —       | Filter by name contains - case insensitive. |
| `status`       | string  | No       | —       | Filter by status.                           |
| `sortBy`       | string  | No       | —       | Sort by. Default value dateModified.        |
| `sortOrder`    | string  | No       | —       | Sort Order. Default value desc.             |
| `pageNumber`   | integer | No       | —       | Page number.                                |
| `pageSize`     | integer | No       | —       | Page size. The maximum page size is 100.    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Filter by matching name - case insensitive."
      },
      "nameContains": {
        "type": "string",
        "description": "Filter by name contains - case insensitive."
      },
      "status": {
        "type": "string",
        "description": "Filter by status.",
        "enum": [
          "Draft",
          "Published"
        ]
      },
      "sortBy": {
        "type": "string",
        "description": "Sort by. Default value dateModified.",
        "enum": [
          "dateModified",
          "name",
          "status"
        ]
      },
      "sortOrder": {
        "type": "string",
        "description": "Sort Order. Default value desc.",
        "enum": [
          "asc",
          "desc"
        ]
      },
      "pageNumber": {
        "type": "integer",
        "description": "Page number."
      },
      "pageSize": {
        "type": "integer",
        "description": "Page size. The maximum page size is 100."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_patch\_guide

Update a guide.

**Parameters:**

| Parameter | Type   | Required | Default | Description            |
| --------- | ------ | -------- | ------- | ---------------------- |
| `guideId` | string | Yes      | —       | Guide ID               |
| `name`    | string | No       | —       | The name of the guide. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "name": {
        "type": "string",
        "description": "The name of the guide."
      }
    },
    "required": [
      "PCID",
      "guideId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_patch\_guide\_version

Update a guide version.

**Parameters:**

| Parameter           | Type      | Required | Default | Description                                                                                                                                    |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `guideId`           | string    | Yes      | —       | Guide ID                                                                                                                                       |
| `versionId`         | string    | Yes      | —       | Version ID                                                                                                                                     |
| `instruction`       | string    | No       | —       | The instruction given to this version of the guide, for how it should behave when interacting with a User.                                     |
| `knowledgeSettings` | object    | No       | —       | Knowledge Settings                                                                                                                             |
| `resources`         | object    | No       | —       | The resources value                                                                                                                            |
| `variables`         | object\[] | No       | —       | The variables associated with this version of the guide. Includes input variables (provided) and output variables (captured during execution). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      },
      "instruction": {
        "type": "string",
        "description": "The instruction given to this version of the guide, for how it should behave when interacting with a User."
      },
      "knowledgeSettings": {
        "type": "object",
        "description": "Knowledge Settings",
        "properties": {
          "knowledgeId": {
            "type": "string",
            "description": "The ID of the knowledge settings to use"
          },
          "description": {
            "type": "string",
            "description": "Description of the knowledge settings"
          },
          "knowledgeType": {
            "type": "string",
            "description": "The type of the knowledge settings (Standard or Enhanced)",
            "enum": [
              "Standard",
              "Enhanced"
            ]
          },
          "inheritFromExternal": {
            "type": "boolean",
            "description": "Whether to inherit knowledge settings from externalIf disabled, query detection is always enabled on the guide."
          }
        }
      },
      "resources": {
        "type": "object",
        "description": "The resources value",
        "properties": {
          "dataActions": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The data actions associated with this version of the guide."
          }
        }
      },
      "variables": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "The name of the variable."
            },
            "type": {
              "type": "string",
              "enum": [
                "String",
                "Integer",
                "Number",
                "Boolean",
                "Date",
                "List"
              ],
              "description": "The data type of the variable."
            },
            "scope": {
              "type": "string",
              "enum": [
                "Input",
                "Output",
                "InputAndOutput",
                "GuideOnly"
              ],
              "description": "The scope that determines the variable's usage context within Guides runtime."
            },
            "description": {
              "type": "string",
              "description": "The description of the variable used by Guides runtime for input/output handling."
            },
            "validation": {
              "type": "object",
              "description": "The validation value"
            },
            "listValues": {
              "type": "object",
              "description": "List Values"
            },
            "listVariables": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "description": "The variables that the list result will be stored in. Only applicable when type is 'List'."
            }
          },
          "required": [
            "name",
            "scope",
            "type"
          ]
        },
        "description": "The variables associated with this version of the guide. Includes input variables (provided) and output variables (captured during execution)."
      }
    },
    "required": [
      "PCID",
      "guideId",
      "versionId"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_patch\_virtualagent

Update a virtual agent.

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                 |
| ---------------- | ------ | -------- | ------- | ------------------------------------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID                            |
| `imageUri`       | string | No       | —       | The URI of the image for the virtual agent. |
| `name`           | string | Yes      | —       | The name of the virtual agent.              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      },
      "imageUri": {
        "type": "string",
        "description": "The URI of the image for the virtual agent."
      },
      "name": {
        "type": "string",
        "description": "The name of the virtual agent."
      }
    },
    "required": [
      "PCID",
      "virtualAgentId",
      "name"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_patch\_virtualagent\_version

Update a virtual agent version.

**Parameters:**

| Parameter        | Type   | Required | Default | Description                            |
| ---------------- | ------ | -------- | ------- | -------------------------------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID                       |
| `versionId`      | string | Yes      | —       | Version ID                             |
| `definition`     | object | Yes      | —       | Definition of a virtual agent version. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      },
      "definition": {
        "type": "object",
        "description": "Definition of a virtual agent version.",
        "properties": {
          "role": {
            "type": "string",
            "description": "A brief description of the virtual agent's high-level capabilities. Specific policies go in the instructions field."
          },
          "instructions": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of instructions, rules, or guidelines the virtual agent must always follow."
          },
          "guardrails": {
            "type": "object",
            "description": "Guardrail rules for a virtual agent."
          },
          "tools": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Tools available to the virtual agent. Each tool is a single action the virtual agent can take, and the virtual agent can call multiple tools in a single turn before responding to the user."
          },
          "types": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Types the virtual agent can use for tool inputs, return types, and errors."
          },
          "events": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Event settings for the virtual agent. Guardrails events configure generated guardrail behavior."
          },
          "settings": {
            "type": "object",
            "description": "Runtime behavior settings for a virtual agent."
          }
        },
        "required": [
          "instructions",
          "role"
        ]
      }
    },
    "required": [
      "PCID",
      "virtualAgentId",
      "versionId",
      "definition"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_conversations\_summaries\_preview

Trigger summary preview event generation.

**Parameters:**

| Parameter                 | Type   | Required | Default | Description                                     |
| ------------------------- | ------ | -------- | ------- | ----------------------------------------------- |
| `summaryPreviewSessionId` | string | Yes      | —       | Session identifier of the summary preview.      |
| `summarySetting`          | object | Yes      | —       | Summary Setting                                 |
| `transcript`              | string | Yes      | —       | Example transcript to preview with the setting. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "summaryPreviewSessionId": {
        "type": "string",
        "description": "Session identifier of the summary preview."
      },
      "summarySetting": {
        "type": "object",
        "description": "Summary Setting",
        "properties": {
          "id": {
            "type": "string",
            "description": "The globally unique identifier for the object."
          },
          "name": {
            "type": "string",
            "description": "Name of the summary setting."
          },
          "dateModified": {
            "type": "string",
            "description": "The date and time the setting was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
          },
          "interactionType": {
            "type": "string",
            "description": "The interaction type the setting can be used for",
            "enum": [
              "Live",
              "Email"
            ]
          },
          "language": {
            "type": "string",
            "description": "Language of the generated summary, e.g. en-US, it-IT."
          },
          "summaryType": {
            "type": "string",
            "description": "Level of detail of the generated summary.",
            "enum": [
              "Concise",
              "Detailed"
            ]
          },
          "format": {
            "type": "string",
            "description": "Format of the generated summary.",
            "enum": [
              "TextBlock",
              "BulletPoints",
              "GroupedTextBlocks",
              "GroupedBulletPoints"
            ]
          },
          "maskPII": {
            "type": "object",
            "description": "Mask PII"
          },
          "dateCreated": {
            "type": "string",
            "description": "The date and time the setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
          },
          "participantLabels": {
            "type": "object",
            "description": "Participant Labels"
          },
          "predefinedInsights": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ReasonForCall",
                "Resolution",
                "ActionItems"
              ]
            },
            "description": "Set which insights to include in the generated summary by default."
          },
          "customEntities": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Custom entity definition."
          },
          "settingType": {
            "type": "string",
            "description": "Type of the summary setting.",
            "enum": [
              "Basic",
              "Prompt"
            ]
          },
          "prompt": {
            "type": "string",
            "description": "Custom prompt of summary setting."
          },
          "serviceType": {
            "type": "string",
            "description": "Service type for summarization. Can be 'Native' for Genesys native summarization engine or 'External' for external service. If specified as 'External', integrationId must be provided.",
            "enum": [
              "Native",
              "External"
            ]
          },
          "integrationId": {
            "type": "string",
            "description": "Integration ID for the external summarization service. Required when serviceType is External."
          },
          "timeoutDuration": {
            "type": "integer",
            "description": "Timeout duration in seconds for the external summarization service request."
          },
          "selfUri": {
            "type": "string",
            "description": "The URI for this object"
          }
        },
        "required": [
          "language",
          "name"
        ]
      },
      "transcript": {
        "type": "string",
        "description": "Example transcript to preview with the setting."
      }
    },
    "required": [
      "PCID",
      "summaryPreviewSessionId",
      "summarySetting",
      "transcript"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_conversations\_summaries\_settings

Create a summary setting.

**Parameters:**

| Parameter            | Type      | Required | Default | Description                                                                                                                                                                             |
| -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `customEntities`     | object\[] | No       | —       | Custom entity definition.                                                                                                                                                               |
| `dateCreated`        | string    | No       | —       | The date and time the setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z                                                     |
| `dateModified`       | string    | No       | —       | The date and time the setting was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z                                               |
| `format`             | string    | No       | —       | Format of the generated summary.                                                                                                                                                        |
| `id`                 | string    | No       | —       | The globally unique identifier for the object.                                                                                                                                          |
| `integrationId`      | string    | No       | —       | Integration ID for the external summarization service. Required when serviceType is External.                                                                                           |
| `interactionType`    | string    | No       | —       | The interaction type the setting can be used for                                                                                                                                        |
| `language`           | string    | Yes      | —       | Language of the generated summary, e.g. en-US, it-IT.                                                                                                                                   |
| `maskPII`            | object    | No       | —       | Mask PII                                                                                                                                                                                |
| `name`               | string    | Yes      | —       | Name of the summary setting.                                                                                                                                                            |
| `participantLabels`  | object    | No       | —       | Participant Labels                                                                                                                                                                      |
| `predefinedInsights` | string\[] | No       | —       | Set which insights to include in the generated summary by default.                                                                                                                      |
| `prompt`             | string    | No       | —       | Custom prompt of summary setting.                                                                                                                                                       |
| `selfUri`            | string    | No       | —       | The URI for this object                                                                                                                                                                 |
| `serviceType`        | string    | No       | —       | Service type for summarization. Can be 'Native' for Genesys native summarization engine or 'External' for external service. If specified as 'External', integrationId must be provided. |
| `settingType`        | string    | No       | —       | Type of the summary setting.                                                                                                                                                            |
| `summaryType`        | string    | No       | —       | Level of detail of the generated summary.                                                                                                                                               |
| `timeoutDuration`    | integer   | No       | —       | Timeout duration in seconds for the external summarization service request.                                                                                                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "customEntities": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "label": {
              "type": "string",
              "description": "Label how the entity should be called."
            },
            "description": {
              "type": "string",
              "description": "Describe the information the entity captures."
            }
          }
        },
        "description": "Custom entity definition."
      },
      "dateCreated": {
        "type": "string",
        "description": "The date and time the setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
      },
      "dateModified": {
        "type": "string",
        "description": "The date and time the setting was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
      },
      "format": {
        "type": "string",
        "description": "Format of the generated summary.",
        "enum": [
          "TextBlock",
          "BulletPoints",
          "GroupedTextBlocks",
          "GroupedBulletPoints"
        ]
      },
      "id": {
        "type": "string",
        "description": "The globally unique identifier for the object."
      },
      "integrationId": {
        "type": "string",
        "description": "Integration ID for the external summarization service. Required when serviceType is External."
      },
      "interactionType": {
        "type": "string",
        "description": "The interaction type the setting can be used for",
        "enum": [
          "Live",
          "Email"
        ]
      },
      "language": {
        "type": "string",
        "description": "Language of the generated summary, e.g. en-US, it-IT."
      },
      "maskPII": {
        "type": "object",
        "description": "Mask PII",
        "properties": {
          "all": {
            "type": "boolean",
            "description": "Toggle PII visibility in summary."
          }
        },
        "required": [
          "all"
        ]
      },
      "name": {
        "type": "string",
        "description": "Name of the summary setting."
      },
      "participantLabels": {
        "type": "object",
        "description": "Participant Labels",
        "properties": {
          "internal": {
            "type": "string",
            "description": "Specify how to refer the internal participant of the interaction."
          },
          "external": {
            "type": "string",
            "description": "Specify how to refer the external participant of the interaction."
          }
        }
      },
      "predefinedInsights": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "ReasonForCall",
            "Resolution",
            "ActionItems"
          ]
        },
        "description": "Set which insights to include in the generated summary by default."
      },
      "prompt": {
        "type": "string",
        "description": "Custom prompt of summary setting."
      },
      "selfUri": {
        "type": "string",
        "description": "The URI for this object"
      },
      "serviceType": {
        "type": "string",
        "description": "Service type for summarization. Can be 'Native' for Genesys native summarization engine or 'External' for external service. If specified as 'External', integrationId must be provided.",
        "enum": [
          "Native",
          "External"
        ]
      },
      "settingType": {
        "type": "string",
        "description": "Type of the summary setting.",
        "enum": [
          "Basic",
          "Prompt"
        ]
      },
      "summaryType": {
        "type": "string",
        "description": "Level of detail of the generated summary.",
        "enum": [
          "Concise",
          "Detailed"
        ]
      },
      "timeoutDuration": {
        "type": "integer",
        "description": "Timeout duration in seconds for the external summarization service request."
      }
    },
    "required": [
      "PCID",
      "language",
      "name"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_guide\_session\_turns

Add a turn to a guide session.

**Parameters:**

| Parameter           | Type      | Required | Default | Description                        |
| ------------------- | --------- | -------- | ------- | ---------------------------------- |
| `guideId`           | string    | Yes      | —       | Guide ID                           |
| `guideSessionId`    | string    | Yes      | —       | Guide Session ID                   |
| `inputEvent`        | object    | Yes      | —       | Input Event                        |
| `inputVariables`    | object\[] | No       | —       | The input variables for this turn. |
| `knowledgeSettings` | object    | No       | —       | Knowledge Settings                 |
| `languageCode`      | string    | Yes      | —       | The language code for this turn.   |
| `entityVersion`     | string    | Yes      | —       | The version for this turn.         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "guideSessionId": {
        "type": "string",
        "description": "Guide Session ID"
      },
      "inputEvent": {
        "type": "object",
        "description": "Input Event",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of input event.",
            "enum": [
              "UserInput",
              "ReturnControl",
              "NoOp"
            ]
          },
          "text": {
            "type": "string",
            "description": "The text content of the input event."
          },
          "mode": {
            "type": "string",
            "description": "The input mode for this event.",
            "enum": [
              "Text"
            ]
          },
          "invocationId": {
            "type": "string",
            "description": "The invocation ID of the input event."
          },
          "invocations": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The invocation data of the input event."
          }
        },
        "required": [
          "mode",
          "type"
        ]
      },
      "inputVariables": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "The name of the variable."
            },
            "value": {
              "type": "string",
              "description": "The value of the variable."
            }
          }
        },
        "description": "The input variables for this turn."
      },
      "knowledgeSettings": {
        "type": "object",
        "description": "Knowledge Settings",
        "properties": {
          "knowledgeId": {
            "type": "string",
            "description": "The ID of the knowledge settings to use"
          },
          "description": {
            "type": "string",
            "description": "Description of the knowledge settings"
          },
          "knowledgeType": {
            "type": "string",
            "description": "The type of the knowledge settings (Standard or Enhanced)",
            "enum": [
              "Standard",
              "Enhanced"
            ]
          }
        }
      },
      "languageCode": {
        "type": "string",
        "description": "The language code for this turn."
      },
      "entityVersion": {
        "type": "string",
        "description": "The version for this turn."
      }
    },
    "required": [
      "PCID",
      "guideId",
      "guideSessionId",
      "inputEvent",
      "languageCode",
      "entityVersion"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_guide\_version\_jobs

Start the publishing of a guide version.

**Parameters:**

| Parameter      | Type   | Required | Default | Description   |
| -------------- | ------ | -------- | ------- | ------------- |
| `guideId`      | string | Yes      | —       | Guide ID      |
| `versionId`    | string | Yes      | —       | Version ID    |
| `guideVersion` | object | Yes      | —       | Guide Version |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      },
      "guideVersion": {
        "type": "object",
        "description": "Guide Version",
        "properties": {
          "state": {
            "type": "string",
            "description": "The desired state of the guide version being published.",
            "enum": [
              "TestReady",
              "ProductionReady"
            ]
          }
        }
      }
    },
    "required": [
      "PCID",
      "guideId",
      "versionId",
      "guideVersion"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_guide\_versions

Create a guide version.

**Parameters:**

| Parameter           | Type      | Required | Default | Description                                                                                                                                    |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `guideId`           | string    | Yes      | —       | Guide ID                                                                                                                                       |
| `instruction`       | string    | Yes      | —       | The instruction given to this version of the guide, for how it should behave when interacting with a User.                                     |
| `knowledgeSettings` | object    | No       | —       | Knowledge Settings                                                                                                                             |
| `resources`         | object    | No       | —       | The resources value                                                                                                                            |
| `variables`         | object\[] | No       | —       | The variables associated with this version of the guide. Includes input variables (provided) and output variables (captured during execution). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "guideId": {
        "type": "string",
        "description": "Guide ID"
      },
      "instruction": {
        "type": "string",
        "description": "The instruction given to this version of the guide, for how it should behave when interacting with a User."
      },
      "knowledgeSettings": {
        "type": "object",
        "description": "Knowledge Settings",
        "properties": {
          "knowledgeId": {
            "type": "string",
            "description": "The ID of the knowledge settings to use"
          },
          "description": {
            "type": "string",
            "description": "Description of the knowledge settings"
          },
          "knowledgeType": {
            "type": "string",
            "description": "The type of the knowledge settings (Standard or Enhanced)",
            "enum": [
              "Standard",
              "Enhanced"
            ]
          },
          "inheritFromExternal": {
            "type": "boolean",
            "description": "Whether to inherit knowledge settings from externalIf disabled, query detection is always enabled on the guide."
          }
        }
      },
      "resources": {
        "type": "object",
        "description": "The resources value",
        "properties": {
          "dataActions": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "The data actions associated with this version of the guide."
          }
        }
      },
      "variables": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "The name of the variable."
            },
            "type": {
              "type": "string",
              "enum": [
                "String",
                "Integer",
                "Number",
                "Boolean",
                "Date",
                "List"
              ],
              "description": "The data type of the variable."
            },
            "scope": {
              "type": "string",
              "enum": [
                "Input",
                "Output",
                "InputAndOutput",
                "GuideOnly"
              ],
              "description": "The scope that determines the variable's usage context within Guides runtime."
            },
            "description": {
              "type": "string",
              "description": "The description of the variable used by Guides runtime for input/output handling."
            },
            "validation": {
              "type": "object",
              "description": "The validation value"
            },
            "listValues": {
              "type": "object",
              "description": "List Values"
            },
            "listVariables": {
              "type": "array",
              "items": {
                "type": "object"
              },
              "description": "The variables that the list result will be stored in. Only applicable when type is 'List'."
            }
          },
          "required": [
            "name",
            "scope",
            "type"
          ]
        },
        "description": "The variables associated with this version of the guide. Includes input variables (provided) and output variables (captured during execution)."
      }
    },
    "required": [
      "PCID",
      "guideId",
      "instruction"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_guides

Create a guide.

**Parameters:**

| Parameter | Type   | Required | Default | Description                                    |
| --------- | ------ | -------- | ------- | ---------------------------------------------- |
| `name`    | string | Yes      | —       | The name of the guide.                         |
| `source`  | string | Yes      | —       | Indicates how the guide content was generated. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "The name of the guide."
      },
      "source": {
        "type": "string",
        "description": "Indicates how the guide content was generated.",
        "enum": [
          "Manual",
          "Prompt",
          "Document",
          "Transcripts"
        ]
      }
    },
    "required": [
      "PCID",
      "name",
      "source"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_guides\_jobs

Start a guide content generation job.

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                              |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `description` | string | No       | —       | The description that you wish to use to generate the guide content from. |
| `url`         | string | No       | —       | The URL of the file you wish to use to generate the guide content from.  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "description": {
        "type": "string",
        "description": "The description that you wish to use to generate the guide content from."
      },
      "url": {
        "type": "string",
        "description": "The URL of the file you wish to use to generate the guide content from."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_guides\_uploads

Generate presigned URL for uploading a file content to generate guide

**Parameters:**

| Parameter                 | Type    | Required | Default | Description                                                                                                                                                                  |
| ------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contentMd5`              | string  | No       | —       | Content MD5 of the file to upload                                                                                                                                            |
| `contentType`             | string  | No       | —       | The content type of the file to upload. Allows all MIME types                                                                                                                |
| `fileName`                | string  | No       | —       | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \&#123;^}%\`]">\[\~\<#\| |
| `serverSideEncryption`    | string  | No       | —       | Server Side Encryption                                                                                                                                                       |
| `signedUrlTimeoutSeconds` | integer | No       | —       | The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds                                                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "contentMd5": {
        "type": "string",
        "description": "Content MD5 of the file to upload"
      },
      "contentType": {
        "type": "string",
        "description": "The content type of the file to upload. Allows all MIME types"
      },
      "fileName": {
        "type": "string",
        "description": "Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"
      },
      "serverSideEncryption": {
        "type": "string",
        "description": "Server Side Encryption",
        "enum": [
          "AES256"
        ]
      },
      "signedUrlTimeoutSeconds": {
        "type": "integer",
        "description": "The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_virtualagent\_version\_jobs

Start the publishing of a virtual agent version.

**Parameters:**

| Parameter             | Type   | Required | Default | Description           |
| --------------------- | ------ | -------- | ------- | --------------------- |
| `virtualAgentId`      | string | Yes      | —       | Virtual Agent ID      |
| `versionId`           | string | Yes      | —       | Version ID            |
| `virtualAgentVersion` | object | Yes      | —       | Virtual Agent Version |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      },
      "versionId": {
        "type": "string",
        "description": "Version ID"
      },
      "virtualAgentVersion": {
        "type": "object",
        "description": "Virtual Agent Version",
        "properties": {
          "status": {
            "type": "string",
            "description": "The status of the virtual agent version to update as part of this publish job.",
            "enum": [
              "TestReady",
              "ProductionReady"
            ]
          }
        },
        "required": [
          "status"
        ]
      }
    },
    "required": [
      "PCID",
      "virtualAgentId",
      "versionId",
      "virtualAgentVersion"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_virtualagent\_versions

Create a virtual agent version.

**Parameters:**

| Parameter        | Type   | Required | Default | Description                            |
| ---------------- | ------ | -------- | ------- | -------------------------------------- |
| `virtualAgentId` | string | Yes      | —       | Virtual Agent ID                       |
| `definition`     | object | Yes      | —       | Definition of a virtual agent version. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "virtualAgentId": {
        "type": "string",
        "description": "Virtual Agent ID"
      },
      "definition": {
        "type": "object",
        "description": "Definition of a virtual agent version.",
        "properties": {
          "role": {
            "type": "string",
            "description": "A brief description of the virtual agent's high-level capabilities. Specific policies go in the instructions field."
          },
          "instructions": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of instructions, rules, or guidelines the virtual agent must always follow."
          },
          "guardrails": {
            "type": "object",
            "description": "Guardrail rules for a virtual agent."
          },
          "tools": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Tools available to the virtual agent. Each tool is a single action the virtual agent can take, and the virtual agent can call multiple tools in a single turn before responding to the user."
          },
          "types": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Types the virtual agent can use for tool inputs, return types, and errors."
          },
          "events": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Event settings for the virtual agent. Guardrails events configure generated guardrail behavior."
          },
          "settings": {
            "type": "object",
            "description": "Runtime behavior settings for a virtual agent."
          }
        },
        "required": [
          "instructions",
          "role"
        ]
      }
    },
    "required": [
      "PCID",
      "virtualAgentId",
      "definition"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_post\_virtualagents

Create a virtual agent.

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                 |
| ---------- | ------ | -------- | ------- | ------------------------------------------- |
| `imageUri` | string | No       | —       | The URI of the image for the virtual agent. |
| `name`     | string | Yes      | —       | The name of the virtual agent.              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "imageUri": {
        "type": "string",
        "description": "The URI of the image for the virtual agent."
      },
      "name": {
        "type": "string",
        "description": "The name of the virtual agent."
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## genesys-ai-studio\_put\_conversations\_summaries\_setting

Update a summary setting.

**Parameters:**

| Parameter            | Type      | Required | Default | Description                                                                                                                                                                             |
| -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `summarySettingId`   | string    | Yes      | —       | Summary setting id                                                                                                                                                                      |
| `customEntities`     | object\[] | No       | —       | Custom entity definition.                                                                                                                                                               |
| `dateCreated`        | string    | No       | —       | The date and time the setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z                                                     |
| `dateModified`       | string    | No       | —       | The date and time the setting was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z                                               |
| `format`             | string    | No       | —       | Format of the generated summary.                                                                                                                                                        |
| `id`                 | string    | No       | —       | The globally unique identifier for the object.                                                                                                                                          |
| `integrationId`      | string    | No       | —       | Integration ID for the external summarization service. Required when serviceType is External.                                                                                           |
| `interactionType`    | string    | No       | —       | The interaction type the setting can be used for                                                                                                                                        |
| `language`           | string    | Yes      | —       | Language of the generated summary, e.g. en-US, it-IT.                                                                                                                                   |
| `maskPII`            | object    | No       | —       | Mask PII                                                                                                                                                                                |
| `name`               | string    | Yes      | —       | Name of the summary setting.                                                                                                                                                            |
| `participantLabels`  | object    | No       | —       | Participant Labels                                                                                                                                                                      |
| `predefinedInsights` | string\[] | No       | —       | Set which insights to include in the generated summary by default.                                                                                                                      |
| `prompt`             | string    | No       | —       | Custom prompt of summary setting.                                                                                                                                                       |
| `selfUri`            | string    | No       | —       | The URI for this object                                                                                                                                                                 |
| `serviceType`        | string    | No       | —       | Service type for summarization. Can be 'Native' for Genesys native summarization engine or 'External' for external service. If specified as 'External', integrationId must be provided. |
| `settingType`        | string    | No       | —       | Type of the summary setting.                                                                                                                                                            |
| `summaryType`        | string    | No       | —       | Level of detail of the generated summary.                                                                                                                                               |
| `timeoutDuration`    | integer   | No       | —       | Timeout duration in seconds for the external summarization service request.                                                                                                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "summarySettingId": {
        "type": "string",
        "description": "Summary setting id"
      },
      "customEntities": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "label": {
              "type": "string",
              "description": "Label how the entity should be called."
            },
            "description": {
              "type": "string",
              "description": "Describe the information the entity captures."
            }
          }
        },
        "description": "Custom entity definition."
      },
      "dateCreated": {
        "type": "string",
        "description": "The date and time the setting was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
      },
      "dateModified": {
        "type": "string",
        "description": "The date and time the setting was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
      },
      "format": {
        "type": "string",
        "description": "Format of the generated summary.",
        "enum": [
          "TextBlock",
          "BulletPoints",
          "GroupedTextBlocks",
          "GroupedBulletPoints"
        ]
      },
      "id": {
        "type": "string",
        "description": "The globally unique identifier for the object."
      },
      "integrationId": {
        "type": "string",
        "description": "Integration ID for the external summarization service. Required when serviceType is External."
      },
      "interactionType": {
        "type": "string",
        "description": "The interaction type the setting can be used for",
        "enum": [
          "Live",
          "Email"
        ]
      },
      "language": {
        "type": "string",
        "description": "Language of the generated summary, e.g. en-US, it-IT."
      },
      "maskPII": {
        "type": "object",
        "description": "Mask PII",
        "properties": {
          "all": {
            "type": "boolean",
            "description": "Toggle PII visibility in summary."
          }
        },
        "required": [
          "all"
        ]
      },
      "name": {
        "type": "string",
        "description": "Name of the summary setting."
      },
      "participantLabels": {
        "type": "object",
        "description": "Participant Labels",
        "properties": {
          "internal": {
            "type": "string",
            "description": "Specify how to refer the internal participant of the interaction."
          },
          "external": {
            "type": "string",
            "description": "Specify how to refer the external participant of the interaction."
          }
        }
      },
      "predefinedInsights": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "ReasonForCall",
            "Resolution",
            "ActionItems"
          ]
        },
        "description": "Set which insights to include in the generated summary by default."
      },
      "prompt": {
        "type": "string",
        "description": "Custom prompt of summary setting."
      },
      "selfUri": {
        "type": "string",
        "description": "The URI for this object"
      },
      "serviceType": {
        "type": "string",
        "description": "Service type for summarization. Can be 'Native' for Genesys native summarization engine or 'External' for external service. If specified as 'External', integrationId must be provided.",
        "enum": [
          "Native",
          "External"
        ]
      },
      "settingType": {
        "type": "string",
        "description": "Type of the summary setting.",
        "enum": [
          "Basic",
          "Prompt"
        ]
      },
      "summaryType": {
        "type": "string",
        "description": "Level of detail of the generated summary.",
        "enum": [
          "Concise",
          "Detailed"
        ]
      },
      "timeoutDuration": {
        "type": "integer",
        "description": "Timeout duration in seconds for the external summarization service request."
      }
    },
    "required": [
      "PCID",
      "summarySettingId",
      "language",
      "name"
    ]
  }
  ```
</Expandable>