---
name: watson-assistant-api-methods
title: API methods summary
description: The following tables list the methods that are available with the watsonx Assistant APIs.
last-updated: 2024-12-31
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/watson-assistant?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# API methods summary
{: #api-methods}

The following tables list the methods that are available with the watsonx Assistant APIs.

## Runtime methods
{: #api-methods-runtime}

| Method | Description | Version | Reference |
|:-------|:------------|:-------:|:---------:|
| **Create a session** | Create a new session. A session is used to send user input to a skill and receive responses. It also maintains the state of the conversation. | v2 | [cURL](https://cloud.ibm.com/apidocs/assistant-v2#createsession){: external} [node](https://cloud.ibm.com/apidocs/assistant-v2?code=node#createsession){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v2?code=java#createsession){: external} [python](https://cloud.ibm.com/apidocs/assistant-v2?code=python#createsession){: external} |
| **Delete session** | Deletes a session explicitly before it times out. | v2 | [cURL](https://cloud.ibm.com/apidocs/assistant-v2#deletesession){: external} [node](https://cloud.ibm.com/apidocs/assistant-v2?code=node#deletesession){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v2?code=java#deletesession){: external} [python](https://cloud.ibm.com/apidocs/assistant-v2?code=python#deletesession){: external} |
| **Send user input to assistant (stateful)** | Send user input to an assistant and receive a response, with conversation state (including context data) stored by watsonx Assistant during the session. | v2 | [cURL](https://cloud.ibm.com/apidocs/assistant-v2#message){: external} [node](https://cloud.ibm.com/apidocs/assistant-v2?code=node#message){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v2?code=java#message){: external} [python](https://cloud.ibm.com/apidocs/assistant-v2?code=python#message){: external} |
| **Send user input to assistant (stateless)** | Send user input to an assistant and receive a response, with conversation state (including context data) managed by your application. | v2 | [cURL](https://cloud.ibm.com/apidocs/assistant-v2#message-stateless){: external} [node](https://cloud.ibm.com/apidocs/assistant-v2?code=node#message-stateless){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v2?code=java#message-stateless){: external} [python](https://cloud.ibm.com/apidocs/assistant-v2?code=python#message-stateless){: external} |

## Authoring methods
{: #api-methods-authoring}

| Method | Description | Version | Reference |
|:-------|:------------|:-------:|:---------:|
| **List workspaces** | List the workspaces associated with a watsonx Assistant service instance. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listworkspaces){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listworkspaces){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listworkspaces){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listworkspaces){: external} |
| **Create workspace** | Create a workspace based on component objects. You must provide workspace components that define the content of the new workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createworkspace){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createworkspace){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createworkspace){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createworkspace){: external} |
| **Get information about a workspace** | Get information about a workspace, optionally including all workspace content. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getworkspace){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getworkspace){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getworkspace){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getworkspace){: external} |
| **Update workspace** | Update an existing workspace with new or modified data. You must provide component objects that define the content of the updated workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updateworkspace){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updateworkspace){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updateworkspace){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updateworkspace){: external} |
| **Delete workspace** | Delete a workspace from the service instance. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deleteworkspace){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deleteworkspace){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deleteworkspace){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deleteworkspace){: external} |
| **List intents** | List the intents for a workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listintents){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listintents){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listintents){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listintents){: external} |
| **Create intent** | Create a new intent. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createintent){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createintent){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createintent){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createintent){: external} |
| **Get intent** | Get information about an intent, optionally including all intent content. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getintent){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getintent){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getintent){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getintent){: external} |
| **Update intent** | Update an existing intent with new or modified data. You must provide component objects that define the content of the updated intent. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updateintent){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updateintent){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updateintent){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updateintent){: external} |
| **Delete intent** | Delete an intent from a workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deleteintent){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deleteintent){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deleteintent){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deleteintent){: external} |
| **List user input examples** | List the user input examples for an intent, optionally including contextual entity mentions. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listexamples){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listexamples){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listexamples){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listexamples){: external} |
| **Create user input example** | Add a new user input example to an intent. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createexample){: external} |
| **Get user input example** | Get information about a user input example. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getexample){: external} |
| **Update user input example** | Update the text of a user input example. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updateexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updateexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updateexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updateexample){: external} |
| **Delete user input example** | Delete a user input example from an intent. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deleteexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deleteexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deleteexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deleteexample){: external} |
| **List counterexamples** | List the counterexamples for a workspace. Counterexamples are examples that are marked as irrelevant input. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listcounterexamples){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listcounterexamples){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listcounterexamples){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listcounterexamples){: external} |
| **Create counterexample** | Add a new counterexample to a workspace. Counterexamples are examples that are marked as irrelevant input. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createcounterexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createcounterexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createcounterexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createcounterexample){: external} |
| **Get counterexample** | Get information about a counterexample. Counterexamples are examples that are marked as irrelevant input. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getcounterexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getcounterexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getcounterexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getcounterexample){: external} |
| **Update counterexample** | Update the text of a counterexample. Counterexamples are examples that are marked as irrelevant input. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updatecounterexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updatecounterexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updatecounterexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updatecounterexample){: external} |
| **Delete counterexample** | Delete a counterexample from a workspace. Counterexamples are examples that are marked as irrelevant input. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deletecounterexample){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deletecounterexample){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deletecounterexample){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deletecounterexample){: external} |
| **List entities** | List the entities for a workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listentities){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listentities){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listentities){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listentities){: external} |
| **Create entity** | Create a new entity, or enable a system entity. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createentity){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createentity){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createentity){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createentity){: external} |
| **Get entity** | Get information about an entity, optionally including all entity content. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getentity){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getentity){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getentity){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getentity){: external} |
| **Update entity** | Update an existing entity with new or modified data. You must provide component objects that define the content of the updated entity. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updateentity){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updateentity){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updateentity){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updateentity){: external} |
| **Delete entity** | Delete an entity from a workspace, or disable a system entity. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deleteentity){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deleteentity){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deleteentity){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deleteentity){: external} |
| **List entity mentions** | List mentions for a contextual entity. An entity mention is an occurrence of a contextual entity in the context of an intent user input example. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listmentions){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listmentions){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listmentions){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listmentions){: external} |
| **List entity values** | List the values for an entity. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listvalues){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listvalues){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listvalues){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listvalues){: external} |
| **Add entity value** | Create a new value for an entity. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createvalue){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createvalue){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createvalue){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createvalue){: external} |
| **Get entity value** | Get information about an entity value. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getvalue){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getvalue){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getvalue){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getvalue){: external} |
| **Update entity value** | Update an existing entity value with new or modified data. You must provide component objects that define the content of the updated entity value. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updatevalue){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updatevalue){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updatevalue){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updatevalue){: external} |
| **Delete entity value** | Delete a value from an entity. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deletevalue){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deletevalue){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deletevalue){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deletevalue){: external} |
| **List entity value synonyms** | List the synonyms for an entity value. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listsynonyms){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listsynonyms){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listsynonyms){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listsynonyms){: external} |
| **Add entity value synonym** | Add a new synonym to an entity value. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createsynonym){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createsynonym){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createsynonym){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createsynonym){: external} |
| **Get entity value synonym** | Get information about a synonym of an entity value. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getsynonym){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getsynonym){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getsynonym){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getsynonym){: external} |
| **Update entity value synonym** | Update an existing entity value synonym with new text. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updatesynonym){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updatesynonym){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updatesynonym){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updatesynonym){: external} |
| **Delete entity value synonym** | Delete a synonym from an entity value. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deletesynonym){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deletesynonym){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deletesynonym){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deletesynonym){: external} |
| **List dialog nodes** | List the dialog nodes for a workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listdialognodes){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listdialognodes){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listdialognodes){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listdialognodes){: external} |
| **Create dialog node** | Create a new dialog node. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#createdialognode){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#createdialognode){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#createdialognode){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#createdialognode){: external} |
| **Get dialog node** | Get information about a dialog node. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#getdialognode){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#getdialognode){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#getdialognode){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#getdialognode){: external} |
| **Update dialog node** | Update an existing dialog node with new or modified data. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#updatedialognode){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#updatedialognode){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#updatedialognode){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#updatedialognode){: external} |
| **Delete dialog node** | Delete a dialog node from a workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deletedialognode){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deletedialognode){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deletedialognode){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deletedialognode){: external} |
| **List log events in a workspace** | List the events from the log of a specific workspace. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listlogs){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listlogs){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listlogs){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listlogs){: external} |
| **List log events in all workspaces** | List the events from the logs of all workspaces in the service instance. | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#listalllogs){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#listalllogs){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#listalllogs){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#listalllogs){: external} |
| **Delete labeled data** | Deletes all data that is associated with a specified customer ID. The method has no effect if no data is associated with the customer ID.  | v1 | [cURL](https://cloud.ibm.com/apidocs/assistant-v1#deleteuserdata){: external} [node](https://cloud.ibm.com/apidocs/assistant-v1?code=node#deleteuserdata){: external} [Java](https://cloud.ibm.com/apidocs/assistant-v1?code=java#deleteuserdata){: external} [python](https://cloud.ibm.com/apidocs/assistant-v1?code=python#deleteuserdata){: external} |