### Example response for Get a list of skill sets

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--skills-and-skill-sets

An example of a successful response when retrieving a list of skill sets. It includes details such as assistant ID, name, and type for each skill set.

```JSON
{
  "skillsets": [
    {
      "assistant_id": "00000000-0000-0000-0000-000000000000",
      "description": "",
      "name": "My skill set",
      "skillset_id": "00000000-0000-0000-0000-000000000000",
      "url": "https://api.example.watson-orchestrate.ibm.com/instances/00000000-0000-0000-0000-000000000000/v1/skillsets/00000000-0000-0000-0000-000000000000",
      "type": "ASSISTANT"
    }
  ]
}
```

--------------------------------

### Example Workspace Creation Response

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--workspace-and-account-management

This is an example of a successful response (201 Created) when creating a new workspace. It includes details such as the workspace ID, tenant ID, and creation metadata.

```json
{
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "tenant_id": "tenant-123",
  "name": "Marketing Team Workspace",
  "description": "Workspace for marketing automation agents",
  "created_by": "IBMid-662002K7XL",
  "created_on": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "role": "owner"
}
```

--------------------------------

### Example Successful Response

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-deployment

This is an example of a successful JSON response when retrieving agent releases. It includes details about each release such as its ID, name, version, and associated configurations.

```json
[
  {
    "id": "60446276-13c6-52da-9996-2419545e5024",
    "tenant_id": "321457785667584",
    "name": "Lois Ingram",
    "description": "Tatkuv pegi goren di zu niorto viewfi mit uf tuwro lekun vegabre.",
    "version_label": 41819135,
    "instructions": "zeplad",
    "tools": [
      "romvu"
    ],
    "collaborators": [
      "ropo"
    ],
    "llm": "fuwkiriz",
    "style": "react",
    "supported_apps": [
      "slack/askhr"
    ],
    "points_to": [],
    "comments": "sersa",
    "mapped_environments": [
      {
        "id": "352e0938-257d-59eb-ad14-7da14fedad51",
        "name": "Ruby Cohen",
        "current_version": 48326951
      }
    ],
    "created_by": "baktezwo",
    "created_on": "2000-08-20T04:43:23.284Z",
    "updated_by": "7/8/2119",
    "updated_at": "2020-08-05T07:23:55.567Z",
    "deleted_by": "jile",
    "hidden": false,
    "environments": [],
    "deleted_at": "2020-08-03T22:27:19.252Z",
    "knowledge_base": [
      "fezu"
    ],
    "display_name": "ukaowojo",
    "structured_output": {
      "id": 3524274285445120
    },
    "guidelines": [],
    "custom_join_tool": {
      "id": 3336379861827584
    },
    "tags": [
      "woecn"
    ],
    "voice_configuration_id": "53783ab1-49a7-5e0b-a158-e08eb2f75a74",
    "deployment_status": "ocedajiw",
    "chat_with_docs": {
      "enabled": false,
      "vector_index": {
        "embeddings_model_name": "coronkop",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10
      },
      "generation": {
        "model_id": "uwhom",
        "prompt_instruction": "",
        "generated_response_length": "Moderate",
        "display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
        "display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
        "idk_message": "I'm afraid I don't understand. Please rephrase your question."
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "unvima"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      }
    },
    "context_access_enabled": true,
    "context_variables": []
  }
]
```

--------------------------------

### Successful Response Example

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-testing-and-evaluation

This is an example of a successful response when retrieving a V2 test case template. It returns a JSON object with an 'id' field.

```json
{
  "id": 6960381689856000
}
```

--------------------------------

### Get Releases for a Specific Environment (On-Premises)

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-deployment

Use this URL to retrieve all registered agents for a specific environment in an on-premises deployment. Replace placeholders with your specific values.

```bash
https://{onprem_url}:{port}/namespace/{namespace}/instances/{instanceid}/v1/orchestrate/agents/environment/{environment_name}/releases?include_hidden=REPLACE_THIS_VALUE
```

--------------------------------

### Get Releases for a Specific Environment (Cloud)

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-deployment

Use this URL to retrieve all registered agents for a specific environment in a cloud deployment. Replace placeholders with your specific values.

```bash
https://api.{saas_hostname}/instances/{tenant_id}/v1/orchestrate/agents/environment/{environment_name}/releases?include_hidden=REPLACE_THIS_VALUE
```

--------------------------------

### Get Test Case Template (On-premises)

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-testing-and-evaluation

Use this URL to download a sample V2 test case JSON file in AgentOps Core format for on-premises deployments. Ensure you replace placeholders with your specific environment details.

```URL
https://{onprem_url}:{port}/namespace/{namespace}/instances/{instanceid}/v1/orchestrate/agent/test_case/templates/v2
```

--------------------------------

### Get a list of skill sets

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--skills-and-skill-sets

Retrieves a list of all available skill sets in your tenant. Requires Admin role.

```APIDOC
## Get a list of skill sets

### Description
Retrieves a list of the skill sets available in your tenant. Users must have Admin role to make requests to this operation.

### Method
GET

### Endpoint
SaaS URL: https://api.{hostname}/instances/{tenant_id}/v1/skillsets
On-premises URL: https://{onprem_host}:{port}/orchestrate/{namespace}/instances/{instanceid}/v1/skillsets

### Security
- **bearer**: Authorization token (JWT for AWS, IAM Access Token for IBM Cloud).
- **apiKey (IAM-API_KEY)**: Authorization key for IBM Cloud (IAM API key).
- **apiKey (ZenApiKey)**: Authorization key for on-premises deployments (Zen API key).

### Responses
- **200**: Successfully retrieved the skill sets.
- **404**: Skill sets were not found.
- **500**: Unexpected server error.

### Request Example
```
curl --request GET \
  --url https://api.REPLACE_HOSTNAME_VARIABLE/instances/REPLACE_TENANT_ID_VARIABLE/v1/skillsets \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'IAM-API_KEY: REPLACE_THIS_VALUE' \
  --header 'ZenApiKey: REPLACE_THIS_VALUE' \
  --header 'accept: application/json'
```

### Response Example (200)
```json
{
  "skillsets": [
    {
      "assistant_id": "00000000-0000-0000-0000-000000000000",
      "description": "",
      "name": "My skill set",
      "skillset_id": "00000000-0000-0000-0000-000000000000",
      "url": "https://api.example.watson-orchestrate.ibm.com/instances/00000000-0000-0000-0000-000000000000/v1/skillsets/00000000-0000-0000-0000-000000000000",
      "type": "ASSISTANT"
    }
  ]
}
```
```

--------------------------------

### Get Test Case Template (SaaS)

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-testing-and-evaluation

Use this URL to download a sample V2 test case JSON file in AgentOps Core format for SaaS deployments. Ensure you replace placeholders with your specific tenant and hostname details.

```URL
https://api.{saas_hostname}/instances/{tenant_id}/v1/orchestrate/agent/test_case/templates/v2
```

--------------------------------

### Use a skill based on GET method

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--skills-and-skill-sets

Invokes a skill using the GET HTTP method.

```APIDOC
## Use a skill based on GET method

### Description
Invokes a skill using the GET HTTP method.

### Method
GET

### Endpoint
/skills/{skillId}/invoke
```

--------------------------------

### Get a list of skill sets

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--skills-and-skill-sets

Retrieves a list of all available skill sets in your tenant. Requires Admin role. Use the appropriate SaaS or on-premises URL and provide the correct authorization token.

```cURL
curl --request GET \
  --url SaaS%20URL:%20https://api.REPLACE_HOSTNAME_VARIABLE/instances/REPLACE_TENANT_ID_VARIABLE/v1/skillsets \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'IAM-API_KEY: REPLACE_THIS_VALUE' \
  --header 'ZenApiKey: REPLACE_THIS_VALUE' \
  --header 'accept: application/json'
```

--------------------------------

### Get a list of skill sets

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--skills-and-skill-sets

Retrieves a list of all available skill sets.

```APIDOC
## Get a list of skill sets

### Description
Retrieves a list of all available skill sets.

### Method
GET

### Endpoint
/skillsets
```

--------------------------------

### Upload To S3 cURL Example

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-execution-and-runtime

Use this cURL command to upload artifacts to object storage. Ensure you replace placeholder values like {onprem_url}, {port}, {namespace}, {instanceid}, and {tenant_id} with your specific details. Also, replace 'REPLACE_BEARER_TOKEN' with your actual bearer token and 'REPLACE_THIS_VALUE' with the file content and ID.

```cURL
curl --request POST \
  --url https:///%7Bonprem_url%7D:%7Bport%7D/namespace/%7Bnamespace%7D/instances/%7Binstanceid%7D/v1/orchestrate/upload-to-s3/ \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json' \
  --header 'content-type: multipart/form-data' \
  --form files=REPLACE_THIS_VALUE \
  --form id=REPLACE_THIS_VALUE
```

--------------------------------

### Manage Agent Runs

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tenant-and-platform-management

APIs for starting, interacting with, and retrieving details of agent runs.

```APIDOC
## Upload To S3

### Description
Uploads files to an S3 bucket. This is often a prerequisite for starting agent runs that require data uploads.

### Method
POST

### Endpoint
`/s3/upload`

### Parameters
#### Request Body
- **file** (file) - Required - The file to upload.
- **bucketName** (string) - Required - The name of the S3 bucket.
- **key** (string) - Required - The key (path) for the file in the bucket.

## Start or interact with run stream

### Description
Initiates or interacts with a streaming run for an agent.

### Method
POST

### Endpoint
`/agents/{agentId}/runs/stream`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Request Body
- **input** (object) - Required - The input data for the run stream.

## Execute an agent run

### Description
Executes a run for a specified agent.

### Method
POST

### Endpoint
`/agents/{agentId}/runs`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Request Body
- **input** (object) - Required - The input data for the agent run.

## List agent runs

### Description
Lists all runs for a given agent.

### Method
GET

### Endpoint
`/agents/{agentId}/runs`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

## Get run details

### Description
Retrieves detailed information about a specific agent run.

### Method
GET

### Endpoint
`/agents/{agentId}/runs/{runId}`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.
- **runId** (string) - Required - The ID of the run.

## Stream run events

### Description
Streams events associated with a specific agent run.

### Method
GET

### Endpoint
`/agents/{agentId}/runs/{runId}/events`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.
- **runId** (string) - Required - The ID of the run.
```

--------------------------------

### Get test case template

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-testing-and-evaluation

Download a sample V2 test case JSON file in AgentOps Core format. This endpoint is applicable for AWS, IBM Cloud, and On-premises deployments.

```APIDOC
## GET /v1/orchestrate/agent/test_case/templates/v2

### Description
Download a sample V2 test case JSON file in AgentOps Core format.

### Method
GET

### Endpoint
/v1/orchestrate/agent/test_case/templates/v2

### Parameters

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **id** (integer) - Example ID for the test case template.

#### Response Example
```json
{
  "id": 6960381689856000
}
```

#### Error Response
- **422** - Validation Error
```

--------------------------------

### Get an OpenAPI specification of a skill

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--skills-and-skill-sets

Retrieves the OpenAPI specification for a given skill.

```APIDOC
## Get an OpenAPI specification of a skill

### Description
Retrieves the OpenAPI specification for a given skill.

### Method
GET

### Endpoint
/skills/{skillId}/openapi
```

--------------------------------

### Get Releases for a Specific Environment

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-deployment

Use this cURL command to fetch a list of agent releases for a given environment. Remember to replace placeholder values with your actual environment details and authentication token.

```cURL
curl --request GET \
  --url 'https:///%7Bonprem_url%7D:%7Bport%7D/namespace/%7Bnamespace%7D/instances/%7Binstanceid%7D/v1/orchestrate/agents/environment/REPLACE_ENVIRONMENT_NAME/releases?include_hidden=REPLACE_THIS_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json'
```

--------------------------------

### Welcome Content

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tenant-and-platform-management

APIs for managing welcome content.

```APIDOC
## Get welcome content

### Description
Retrieves the welcome content.

### Method
GET

### Endpoint
`/welcome-content`

## Create or update welcome content

### Description
Creates or updates the welcome content.

### Method
PUT

### Endpoint
`/welcome-content`

### Parameters
#### Request Body
- **content** (string) - Required - The welcome content.

## Delete welcome content

### Description
Deletes the welcome content.

### Method
DELETE

### Endpoint
`/welcome-content`
```

--------------------------------

### Chat Starter Settings

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tenant-and-platform-management

APIs for managing chat starter settings and icons for registered agents.

```APIDOC
## Create or update chat starter settings for a registered agent

### Description
Creates or updates the chat starter settings for a registered agent.

### Method
PUT

### Endpoint
`/agents/{agentId}/chat-starter-settings`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Request Body
- **settings** (object) - Required - The chat starter settings.

## Get chat starter settings for a registered agent

### Description
Retrieves the chat starter settings for a registered agent.

### Method
GET

### Endpoint
`/agents/{agentId}/chat-starter-settings`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

## Delete agent icon or other chat starter settings

### Description
Deletes the agent icon or other specified chat starter settings.

### Method
DELETE

### Endpoint
`/agents/{agentId}/chat-starter-settings`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Query Parameters
- **settingKey** (string) - Required - The key of the setting to delete (e.g., 'icon').

## Upload agent icon (SVG)

### Description
Uploads an SVG icon for the agent.

### Method
POST

### Endpoint
`/agents/{agentId}/chat-starter-settings/icon`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Request Body
- **file** (file) - Required - The SVG file for the agent icon.
```

--------------------------------

### Create a Tool

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tools-and-toolkits

Use this cURL command to create a new tool. Ensure you replace placeholders like `REPLACE_BEARER_TOKEN` and `REPLACE_REQUEST_BODY` with your actual credentials and request data.

```cURL
curl --request POST \
  --url https:///%7Bonprem_url%7D:%7Bport%7D/namespace/%7Bnamespace%7D/instances/%7Binstanceid%7D/v1/orchestrate/tools \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data REPLACE_REQUEST_BODY
```

--------------------------------

### Get a list of skills for a skill set

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--skills-and-skill-sets

Retrieves a list of all skills associated with a specific skill set.

```APIDOC
## Get a list of skills for a skill set

### Description
Retrieves a list of all skills associated with a specific skill set.

### Method
GET

### Endpoint
/skillsets/{skillSetId}/skills
```

--------------------------------

### Create or update chat starter settings for a registered agent

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-management

Use this endpoint to create or update the chat starter settings for a registered agent. It supports on-premises, AWS, and IBM Cloud deployments.

```cURL
https://{onprem_url}:{port}/namespace/{namespace}/instances/{instanceid}/v1/orchestrate/agents/{id}/chat-starter-settings
```

```cURL
https://api.{saas_hostname}/instances/{tenant_id}/v1/orchestrate/agents/{id}/chat-starter-settings
```

--------------------------------

### Get releases for a specific environment

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-deployment

Retrieves a list of agent releases for a given environment, with an option to include hidden releases.

```APIDOC
## GET /v1/orchestrate/agents/environment/{environment_name}/releases

### Description
Retrieves a list of agent releases for a specific environment. You can optionally include hidden releases in the response.

### Method
GET

### Endpoint
/v1/orchestrate/agents/environment/{environment_name}/releases

### Parameters
#### Path Parameters
- **environment_name** (string) - Required - The name of the environment for which to retrieve releases.

#### Query Parameters
- **include_hidden** (boolean) - Optional - Default: false - Whether to include hidden releases in the response.

#### Header Parameters
- **Accept** (string) - Optional - Specifies the desired response format. Default: application/json

### Request Example
```
curl --request GET \
  --url 'https:///%7Bonprem_url%7D:%7Bport%7D/namespace/%7Bnamespace%7D/instances/%7Binstanceid%7D/v1/orchestrate/agents/environment/REPLACE_ENVIRONMENT_NAME/releases?include_hidden=REPLACE_THIS_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json'
```

### Response
#### Success Response (200)
Returns an array of release objects, each containing details about an agent release.
- **id** (string) - The unique identifier of the release.
- **tenant_id** (string) - The identifier of the tenant.
- **name** (string) - The name of the release.
- **description** (string) - A description of the release.
- **version_label** (integer) - The version label of the release.
- **instructions** (string) - Instructions for the release.
- **tools** (array) - A list of tools associated with the release.
- **collaborators** (array) - A list of collaborators for the release.
- **llm** (string) - The language model used.
- **style** (string) - The style of the agent.
- **supported_apps** (array) - A list of applications supported by the agent.
- **points_to** (array) - Points of interest for the release.
- **comments** (string) - Comments related to the release.
- **mapped_environments** (array) - Information about environments mapped to this release.
  - **id** (string) - The environment ID.
  - **name** (string) - The environment name.
  - **current_version** (integer) - The current version in the mapped environment.
- **created_by** (string) - The user who created the release.
- **created_on** (string) - The date and time the release was created.
- **updated_by** (string) - The user who last updated the release.
- **updated_at** (string) - The date and time the release was last updated.
- **deleted_by** (string) - The user who deleted the release.
- **hidden** (boolean) - Indicates if the release is hidden.
- **environments** (array) - List of environments associated with the release.
- **deleted_at** (string) - The date and time the release was deleted.
- **knowledge_base** (array) - A list of knowledge base items.
- **display_name** (string) - The display name of the release.
- **structured_output** (object) - Structured output configuration.
  - **id** (integer) - The ID of the structured output.
- **guidelines** (array) - Guidelines for the release.
- **custom_join_tool** (object) - Custom join tool configuration.
  - **id** (integer) - The ID of the custom join tool.
- **tags** (array) - Tags associated with the release.
- **voice_configuration_id** (string) - The ID of the voice configuration.
- **deployment_status** (string) - The deployment status of the agent.
- **chat_with_docs** (object) - Configuration for chat with docs feature.
  - **enabled** (boolean) - Whether chat with docs is enabled.
  - **vector_index** (object) - Vector index configuration.
    - **embeddings_model_name** (string) - Name of the embeddings model.
    - **chunk_size** (integer) - Size of chunks for indexing.
    - **chunk_overlap** (integer) - Overlap between chunks.
    - **limit** (integer) - Limit for retrieved documents.
  - **generation** (object) - Generation configuration for responses.
    - **model_id** (string) - ID of the generation model.
    - **prompt_instruction** (string) - Prompt instruction for the model.
    - **generated_response_length** (string) - Desired length of the generated response.
    - **display_text_no_results_found** (string) - Text to display when no results are found.
    - **display_text_connectivity_issue** (string) - Text to display on connectivity issues.
    - **idk_message** (string) - Message to display when the agent doesn't understand.
  - **query_rewrite** (object) - Configuration for query rewriting.
    - **enabled** (boolean) - Whether query rewriting is enabled.
    - **model_id** (string) - ID of the query rewrite model.
  - **confidence_thresholds** (object) - Confidence thresholds for retrieval and response.
    - **retrieval_confidence_threshold** (string) - Threshold for retrieval confidence.
    - **response_confidence_threshold** (string) - Threshold for response confidence.
  - **citations** (object) - Citation configuration.
    - **citation_title** (string) - Title for citations.
    - **citations_shown** (integer) - Number of citations to show.
  - **hap_filtering** (object) - HAP filtering configuration.
    - **output** (object) - Output filtering configuration.
      - **enabled** (boolean) - Whether output filtering is enabled.
      - **threshold** (number) - The filtering threshold.
- **context_access_enabled** (boolean) - Whether context access is enabled.
- **context_variables** (array) - List of context variables.

#### Response Example
```json
[
  {
    "id": "60446276-13c6-52da-9996-2419545e5024",
    "tenant_id": "321457785667584",
    "name": "Lois Ingram",
    "description": "Tatkuv pegi goren di zu niorto viewfi mit uf tuwro lekun vegabre.",
    "version_label": 41819135,
    "instructions": "zeplad",
    "tools": [
      "romvu"
    ],
    "collaborators": [
      "ropo"
    ],
    "llm": "fuwkiriz",
    "style": "react",
    "supported_apps": [
      "slack/askhr"
    ],
    "points_to": [],
    "comments": "sersa",
    "mapped_environments": [
      {
        "id": "352e0938-257d-59eb-ad14-7da14fedad51",
        "name": "Ruby Cohen",
        "current_version": 48326951
      }
    ],
    "created_by": "baktezwo",
    "created_on": "2000-08-20T04:43:23.284Z",
    "updated_by": "7/8/2119",
    "updated_at": "2020-08-05T07:23:55.567Z",
    "deleted_by": "jile",
    "hidden": false,
    "environments": [],
    "deleted_at": "2020-08-03T22:27:19.252Z",
    "knowledge_base": [
      "fezu"
    ],
    "display_name": "ukaowojo",
    "structured_output": {
      "id": 3524274285445120
    },
    "guidelines": [],
    "custom_join_tool": {
      "id": 3336379861827584
    },
    "tags": [
      "woecn"
    ],
    "voice_configuration_id": "53783ab1-49a7-5e0b-a158-e08eb2f75a74",
    "deployment_status": "ocedajiw",
    "chat_with_docs": {
      "enabled": false,
      "vector_index": {
        "embeddings_model_name": "coronkop",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10
      },
      "generation": {
        "model_id": "uwhom",
        "prompt_instruction": "",
        "generated_response_length": "Moderate",
        "display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
        "display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
        "idk_message": "I'm afraid I don't understand. Please rephrase your question."
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "unvima"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      }
    },
    "context_access_enabled": true,
    "context_variables": []
  }
]
```

#### Validation Error (422)
Returned when the request parameters are invalid.
```

--------------------------------

### Get releases for a specific environment

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-deployment

Lists all registered agents for a given environment. This endpoint is applicable to AWS, IBM Cloud, and On-premises deployments.

```APIDOC
## GET /v1/orchestrate/agents/environment/{environment_name}/releases

### Description
Lists all registered agents for a specific environment.

### Method
GET

### Endpoint
/v1/orchestrate/agents/environment/{environment_name}/releases

### Parameters
#### Path Parameters
- **environment_name** (string) - Required - The name of the environment for which to retrieve agent releases.

#### Query Parameters
- **include_hidden** (boolean) - Optional - Whether to include hidden agents in the results.

### Request Example
```
https://{onprem_url}:{port}/namespace/{namespace}/instances/{instanceid}/v1/orchestrate/agents/environment/{environment_name}/releases?include_hidden=true
```
```
https://api.{saas_hostname}/instances/{tenant_id}/v1/orchestrate/agents/environment/{environment_name}/releases?include_hidden=true
```

### Response
#### Success Response (200)
- **agents** (array) - A list of registered agents.
  - **agent_id** (string) - The unique identifier of the agent.
  - **name** (string) - The name of the agent.
  - **version** (string) - The version of the agent.
  - **status** (string) - The current status of the agent (e.g., 'deployed', 'undeployed').
  - **environment** (string) - The environment where the agent is deployed.
  - **created_at** (string) - The timestamp when the agent was created.
  - **updated_at** (string) - The timestamp when the agent was last updated.

#### Response Example
```json
{
  "agents": [
    {
      "agent_id": "agent-123",
      "name": "Customer Support Bot",
      "version": "1.0.0",
      "status": "deployed",
      "environment": "production",
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Create or update chat starter settings for a registered agent

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--agent-management

This endpoint allows you to create or update the chat starter settings for a specific registered agent.

```APIDOC
## PUT /v1/orchestrate/agents/{id}/chat-starter-settings

### Description
Create or update chat starter settings for a registered agent.

### Method
PUT

### Endpoint
/v1/orchestrate/agents/{id}/chat-starter-settings

### Parameters
#### Path Parameters
- **id** (string) - REQUIRED - The unique identifier of the agent.

#### Header Parameters
- **Content-type** (string) - Optional - Specifies the content type of the request body, defaults to application/json.
- **Accept** (string) - Optional - Specifies the desired response format, defaults to application/json.

### Request Body
(application/json)

### Responses
#### Success Response (200)
Indicates that the chat starter settings were successfully created or updated.

#### Error Response (422)
Indicates a validation error with the request payload.
```

--------------------------------

### Create voice configuration using cURL

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--voice-configurations

Use this cURL command to create a voice configuration. Ensure you replace placeholder values like `REPLACE_BEARER_TOKEN` and `REPLACE_REQUEST_BODY` with your actual credentials and data.

```cURL
curl --request POST \
  --url https:///%7Bonprem_url%7D:%7Bport%7D/namespace/%7Bnamespace%7D/instances/%7Binstanceid%7D/v1/voice_configurations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data REPLACE_REQUEST_BODY
```

--------------------------------

### Retrieve Python Package Allowlist

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tenant-and-platform-management

Use this cURL command to retrieve the Python package allowlist for a tenant. Requires Admin role. Ensure you replace 'REPLACE_BEARER_TOKEN' with your actual bearer token.

```cURL
curl --request GET \
  --url https:///%7Bonprem_url%7D:%7Bport%7D/namespace/%7Bnamespace%7D/instances/%7Binstanceid%7D/v1/tenants/package-config \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json'
```

--------------------------------

### Register watsonx Assistant Instance (cURL)

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--watsonx-assistant-integration

Use this cURL command to register a watsonx Assistant instance. Ensure you replace placeholder values like `REPLACE_BEARER_TOKEN` and `REPLACE_REQUEST_BODY` with your actual credentials and request data.

```cURL
curl --request POST \
  --url https:///%7Bonprem_url%7D:%7Bport%7D/namespace/%7Bnamespace%7D/instances/%7Binstanceid%7D/v1/orchestrate/assistants/watsonx \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data REPLACE_REQUEST_BODY
```

--------------------------------

### Workspace Management

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tenant-and-platform-management

APIs for creating, managing, and interacting with workspaces.

```APIDOC
## Create a new workspace

### Description
Creates a new workspace.

### Method
POST

### Endpoint
`/workspaces`

### Parameters
#### Request Body
- **name** (string) - Required - The name of the workspace.
- **description** (string) - Optional - A description for the workspace.

## List workspaces

### Description
Retrieves a list of all workspaces.

### Method
GET

### Endpoint
`/workspaces`

## Get workspace details

### Description
Retrieves detailed information about a specific workspace.

### Method
GET

### Endpoint
`/workspaces/{workspaceId}`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.

## Update workspace

### Description
Updates an existing workspace.

### Method
PUT

### Endpoint
`/workspaces/{workspaceId}`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.

#### Request Body
- **name** (string) - Optional - The new name for the workspace.
- **description** (string) - Optional - The new description for the workspace.

## Delete workspace

### Description
Deletes a specific workspace.

### Method
DELETE

### Endpoint
`/workspaces/{workspaceId}`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.

## Add member(s) to workspace

### Description
Adds one or more members to a workspace.

### Method
POST

### Endpoint
`/workspaces/{workspaceId}/members`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.

#### Request Body
- **members** (array) - Required - A list of members to add.
  - **userId** (string) - Required - The ID of the user.
  - **role** (string) - Required - The role of the member (e.g., 'admin', 'editor').

## List workspace members

### Description
Retrieves a list of members for a specific workspace.

### Method
GET

### Endpoint
`/workspaces/{workspaceId}/members`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.

## Update workspace member role

### Description
Updates the role of a member within a workspace.

### Method
PUT

### Endpoint
`/workspaces/{workspaceId}/members/{userId}`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.
- **userId** (string) - Required - The ID of the user whose role to update.

#### Request Body
- **role** (string) - Required - The new role for the member.

## Remove member from workspace

### Description
Removes a member from a workspace.

### Method
DELETE

### Endpoint
`/workspaces/{workspaceId}/members/{userId}`

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.
- **userId** (string) - Required - The ID of the user to remove.

## Copy an agent to a workspace

### Description
Copies an agent from one workspace to another.

### Method
POST

### Endpoint
`/workspaces/{targetWorkspaceId}/agents/{agentId}/copy`

### Parameters
#### Path Parameters
- **targetWorkspaceId** (string) - Required - The ID of the workspace to copy the agent to.
- **agentId** (string) - Required - The ID of the agent to copy.
```

--------------------------------

### Create voice configuration

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--voice-configurations

This endpoint allows you to create a new voice configuration. It supports deployment on AWS, IBM Cloud, and on-premises environments.

```APIDOC
## POST /v1/voice_configurations

### Description
Creates a new voice configuration.

### Method
POST

### Endpoint
- For IBM Cloud and AWS: `https://api.{saas_hostname}/instances/{tenant_id}/v1/voice_configurations`
- For On-premises: `https://{onprem_url}:{port}/namespace/{namespace}/instances/{instanceid}/v1/voice_configurations`

### Parameters
#### Header Parameters
- **Content-type** (string) - Required - `application/json`
- **Accept** (string) - Required - `application/json`

### Request Body
- **(object)** - Required - The voice configuration details.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (201)
- **(object)** - Details of the created voice configuration.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Response (422)
- **(object)** - Validation Error details.
```

--------------------------------

### Manage Environments

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tenant-and-platform-management

APIs for managing environments for agents, including creation, retrieval, updates, and deletion.

```APIDOC
## Create an environment for agent

### Description
Creates a new environment for a specified agent.

### Method
POST

### Endpoint
`/agents/{agentId}/environments`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Request Body
- **name** (string) - Required - The name of the environment.
- **description** (string) - Optional - A description for the environment.

## Get environments for agent

### Description
Retrieves a list of environments associated with a specific agent.

### Method
GET

### Endpoint
`/agents/{agentId}/environments`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

## Get a specific environment

### Description
Retrieves details of a specific environment.

### Method
GET

### Endpoint
`/agents/{agentId}/environments/{environmentId}`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.
- **environmentId** (string) - Required - The ID of the environment.

## Update a specific environment

### Description
Updates an existing environment.

### Method
PUT

### Endpoint
`/agents/{agentId}/environments/{environmentId}`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.
- **environmentId** (string) - Required - The ID of the environment.

#### Request Body
- **name** (string) - Optional - The new name for the environment.
- **description** (string) - Optional - The new description for the environment.

## Delete a specific environment

### Description
Deletes a specific environment.

### Method
DELETE

### Endpoint
`/agents/{agentId}/environments/{environmentId}`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.
- **environmentId** (string) - Required - The ID of the environment.
```

--------------------------------

### Tool Management

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--tenant-and-platform-management

APIs for creating, managing, and interacting with tools and toolkits.

```APIDOC
## Create a tool

### Description
Creates a new tool.

### Method
POST

### Endpoint
`/tools`

### Parameters
#### Request Body
- **name** (string) - Required - The name of the tool.
- **description** (string) - Optional - A description of the tool.
- **parameters** (object) - Required - The parameters the tool accepts.

## List all tools

### Description
Retrieves a list of all available tools.

### Method
GET

### Endpoint
`/tools`

## Update a tool

### Description
Updates an existing tool.

### Method
PUT

### Endpoint
`/tools/{toolId}`

### Parameters
#### Path Parameters
- **toolId** (string) - Required - The ID of the tool to update.

#### Request Body
- **updates** (object) - Required - The fields to update for the tool.

## Get tool details

### Description
Retrieves detailed information about a specific tool.

### Method
GET

### Endpoint
`/tools/{toolId}`

### Parameters
#### Path Parameters
- **toolId** (string) - Required - The ID of the tool.

## Delete a tool

### Description
Deletes a specific tool.

### Method
DELETE

### Endpoint
`/tools/{toolId}`

### Parameters
#### Path Parameters
- **toolId** (string) - Required - The ID of the tool to delete.

## Upload tool artifacts

### Description
Uploads artifact files associated with a tool.

### Method
POST

### Endpoint
`/tools/{toolId}/artifacts`

### Parameters
#### Path Parameters
- **toolId** (string) - Required - The ID of the tool.

#### Request Body
- **files** (array) - Required - A list of files to upload as artifacts.

## Download tool artifacts

### Description
Downloads artifact files for a specific tool.

### Method
GET

### Endpoint
`/tools/{toolId}/artifacts`

### Parameters
#### Path Parameters
- **toolId** (string) - Required - The ID of the tool.

## Create a toolkit

### Description
Creates a new toolkit, which is a collection of tools.

### Method
POST

### Endpoint
`/toolkits`

### Parameters
#### Request Body
- **name** (string) - Required - The name of the toolkit.
- **description** (string) - Optional - A description for the toolkit.
- **toolIds** (array) - Required - A list of tool IDs to include in the toolkit.

## List toolkits

### Description
Retrieves a list of all available toolkits.

### Method
GET

### Endpoint
`/toolkits`

## Get toolkit by ID

### Description
Retrieves detailed information about a specific toolkit.

### Method
GET

### Endpoint
`/toolkits/{toolkitId}`

### Parameters
#### Path Parameters
- **toolkitId** (string) - Required - The ID of the toolkit.

## Delete a toolkit by ID

### Description
Deletes a specific toolkit.

### Method
DELETE

### Endpoint
`/toolkits/{toolkitId}`

### Parameters
#### Path Parameters
- **toolkitId** (string) - Required - The ID of the toolkit to delete.

## Preview tools from MCP server without importing

### Description
Previews tools available on the MCP server without importing them into the current environment.

### Method
GET

### Endpoint
`/mcp/tools/preview`

## Upload artifact files for a toolkit

### Description
Uploads artifact files for a specific toolkit.

### Method
POST

### Endpoint
`/toolkits/{toolkitId}/artifacts`

### Parameters
#### Path Parameters
- **toolkitId** (string) - Required - The ID of the toolkit.

#### Request Body
- **files** (array) - Required - A list of files to upload as artifacts.

## Download artifact files from a toolkit

### Description
Downloads artifact files associated with a specific toolkit.

### Method
GET

### Endpoint
`/toolkits/{toolkitId}/artifacts`

### Parameters
#### Path Parameters
- **toolkitId** (string) - Required - The ID of the toolkit.
```

--------------------------------

### Create a new workspace

Source: https://developer.ibm.com/apis/catalog/watsonorchestrate--custom-assistants/api/API--watsonorchestrate--workspace-and-account-management

Use this cURL command to create a new workspace. Ensure you replace `REPLACE_REQUEST_BODY` with the actual JSON payload for the workspace configuration.

```cURL
curl --request POST \
  --url https://api./%7Bsaas_hostname%7D/instances/%7Btenant_id%7D/api/v1/workspaces \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data REPLACE_REQUEST_BODY
```