IBM Cloud Docs
API methods summary

API methods summary

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

Runtime methods

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 node Java python
Delete session Deletes a session explicitly before it times out. v2 cURL node Java python
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 node Java python
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 node Java python

Authoring methods

Method Description Version Reference
List workspaces List the workspaces associated with a watsonx Assistant service instance. v1 cURL node Java python
Create workspace Create a workspace based on component objects. You must provide workspace components that define the content of the new workspace. v1 cURL node Java python
Get information about a workspace Get information about a workspace, optionally including all workspace content. v1 cURL node Java python
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 node Java python
Delete workspace Delete a workspace from the service instance. v1 cURL node Java python
List intents List the intents for a workspace. v1 cURL node Java python
Create intent Create a new intent. v1 cURL node Java python
Get intent Get information about an intent, optionally including all intent content. v1 cURL node Java python
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 node Java python
Delete intent Delete an intent from a workspace. v1 cURL node Java python
List user input examples List the user input examples for an intent, optionally including contextual entity mentions. v1 cURL node Java python
Create user input example Add a new user input example to an intent. v1 cURL node Java python
Get user input example Get information about a user input example. v1 cURL node Java python
Update user input example Update the text of a user input example. v1 cURL node Java python
Delete user input example Delete a user input example from an intent. v1 cURL node Java python
List counterexamples List the counterexamples for a workspace. Counterexamples are examples that are marked as irrelevant input. v1 cURL node Java python
Create counterexample Add a new counterexample to a workspace. Counterexamples are examples that are marked as irrelevant input. v1 cURL node Java python
Get counterexample Get information about a counterexample. Counterexamples are examples that are marked as irrelevant input. v1 cURL node Java python
Update counterexample Update the text of a counterexample. Counterexamples are examples that are marked as irrelevant input. v1 cURL node Java python
Delete counterexample Delete a counterexample from a workspace. Counterexamples are examples that are marked as irrelevant input. v1 cURL node Java python
List entities List the entities for a workspace. v1 cURL node Java python
Create entity Create a new entity, or enable a system entity. v1 cURL node Java python
Get entity Get information about an entity, optionally including all entity content. v1 cURL node Java python
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 node Java python
Delete entity Delete an entity from a workspace, or disable a system entity. v1 cURL node Java python
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 node Java python
List entity values List the values for an entity. v1 cURL node Java python
Add entity value Create a new value for an entity. v1 cURL node Java python
Get entity value Get information about an entity value. v1 cURL node Java python
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 node Java python
Delete entity value Delete a value from an entity. v1 cURL node Java python
List entity value synonyms List the synonyms for an entity value. v1 cURL node Java python
Add entity value synonym Add a new synonym to an entity value. v1 cURL node Java python
Get entity value synonym Get information about a synonym of an entity value. v1 cURL node Java python
Update entity value synonym Update an existing entity value synonym with new text. v1 cURL node Java python
Delete entity value synonym Delete a synonym from an entity value. v1 cURL node Java python
List dialog nodes List the dialog nodes for a workspace. v1 cURL node Java python
Create dialog node Create a new dialog node. v1 cURL node Java python
Get dialog node Get information about a dialog node. v1 cURL node Java python
Update dialog node Update an existing dialog node with new or modified data. v1 cURL node Java python
Delete dialog node Delete a dialog node from a workspace. v1 cURL node Java python
List log events in a workspace List the events from the log of a specific workspace. v1 cURL node Java python
List log events in all workspaces List the events from the logs of all workspaces in the service instance. v1 cURL node Java python
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 node Java python