Available WatsonX APIs

Agent chat starter settings

Create or update chat starter settings for a registered agent

X

Delete agent icon or other chat starter settings

X

Get chat starter settings for a registered agent

X

Upload agent icon (SVG)

X

Create or update chat starter settings for a registered agent

X

Delete agent icon or other chat starter settings

X

Get chat starter settings for a registered agent

X

Upload agent icon (SVG)

X

Agent release environments

Create an environment for agent

X

Delete a specific environment

X

Get a specific environment

X

Get environments for agent

X

Update a specific environment

X

Create an environment for agent

X

Delete a specific environment

X

Get a specific environment

X

Get environments for agent

X

Update a specific environment

X

Agent releases

Create releases for an agent

X

Delete a specific release

X

Deploy a release to specific environment

X

Get a specific release

X

Get releases for a specific environment

X

Get releases for an agent

X

Undeploy a specific release

X

Create releases for an agent

X

Delete a specific release

X

Deploy a release to specific environment

X

Get a specific release

X

Get releases for a specific environment

X

Get releases for an agent

X

Undeploy a specific release

X

Agents

Create agent from catalog template

X

Create agent

X

Delete an agent

X

Get an agent by ID

X

List agents

X

Update an agent

X

Create agent from catalog template

X

Create agent

X

Delete an agent

X

Get an agent by ID

X

List agents

X

Update an agent

X

AI assistant

Delete watsonx assistant instance

X

Get AI assistant instance

X

Update AI assistant instance

X

Delete watsonx assistant instance

X

Get AI assistant instance

X

Update AI assistant instance

X

AI services

Create a new AI service

X

Create a new AI service revision

X

Delete the AI service

X

Download the AI service code

X

Retrieve the AI service

X

Retrieve the AI service revisions

X

Retrieve the AI services

X

Update the AI service

X

Upload the AI service code

X

Assistants runs

Create runs for a specific assistant

X

Get details of a specific run for a given assistant

X

List runs for a specific assistant

X

Create runs for a specific assistant

X

Get details of a specific run for a given assistant

X

List runs for a specific assistant

X

Auto AI RAG

Cancel or delete an auto AI RAG run

X

Create a new auto AI RAG run

X

Get an auto AI RAG run

X

Retrieve the auto AI RAG runs

X

Catalog management

Create an artifact of category webhook

X

Delete an artifact from the catalog

X

Get an artifact's details

X

List all artifacts available in the catalog

X

List all artifacts

X

List all available skills under an application

X

Update an artifact

X

Create an artifact of category webhook

X

Delete an artifact from the catalog

X

Get an artifact's details

X

List all artifacts available in the catalog

X

List all artifacts

X

List all available skills under an application

X

Update an artifact

X

Chat with documents

Get status of document-based chat

X

Initiate a chat using documents with the given agent

X

Get status of document-based chat

X

Initiate a chat using documents with the given agent

X

Cluster schema

Delete the request

X

Get the results of the request

X

Retrieve the cluster schema requests

X

Start a cluster schema request

X

Connections

Creates a new connection

X

Delete connection by ID

X

Get list of connections

X

List a connection based on the provided app ID and shared flag

X

Creates a new connection

X

Delete connection by ID

X

Get list of connections

X

List a connection based on the provided app ID and shared flag

X

Create schema

Delete the request

X

Get the results of the request

X

Retrieve the create schema requests

X

Start a create schema request

X

Default agent settings

List default agent settings

X

Update orchestrate settings

X

List default agent settings

X

Update orchestrate settings

X

Deployments

Create a new WatsonXAI deployment

X

Delete the deployment

X

Execute AI service

X

Execute AI service stream

X

Infer chat completions

X

Infer text chat event stream

X

Infer text chat

X

Infer text event stream

X

Infer text

X

Retrieve the deployment details

X

Retrieve the deployments

X

Time series forecast

X

Update the deployment metadata

X

Document extraction (Beta)

Cancel the document extraction

X

Create a document extraction

X

Get document extraction

X

Get document extractions

X

Embed settings

Create embed settings config

X

Generate IBM-provided public key

X

Get embed settings config

X

Create embed settings config

X

Generate IBM-provided public key

X

Get embed settings config

X

Evaluations

Cancel or delete evaluation with given ID

X

Get evalutation with given ID

X

Get list of evaluations

X

Submit a new evaluation

X

External chat agents

Delete journey definitions

X

Get journey definitions

X

List catalog applications

X

Register catalog applications

X

Update journey definitions

X

Delete journey definitions

X

Get journey definitions

X

List catalog applications

X

Register catalog applications

X

Update journey definitions

X

Fine tunings (Beta)

Cancel or delete a fine tuning job

X

Create a fine tuning job

X

Get a fine tuning job

X

Retrieve the list of fine tuning jobs

X

Flows

Asynchronously run the latest flow version

X

List flow instances

X

Synchronously run the flow

X

Asynchronously run the latest flow version

X

List flow instances

X

Synchronously run the flow

X

Foundation model specs

List the available foundation models

X

List the supported tasks

X

Geospatial (Private)

Create a geospatial transformation

X

Delete a geospatial transformation

X

Get a geospatial transformation

X

Retrieve the geospatial transformation requests

X

GPUs

See available GPUs

X

Improve schema

Delete the request

X

Get the results of the request

X

Retrieve the improve schema requests

X

Start a improve schema request

X

Journey types

Get skill details for a specific catalog application

X

Get skill details for a specific catalog application

X

Knowledge-bases

Create a knowledge-base by uploading documents, or providing a external vector index

X

Delete a KB and ingested documents by ID

X

Delete some ingested documents from a knowledge-base

X

Fetch knowledge-bases

X

Get a KB by ID

X

Ingest additional documents into a knowledge-base

X

Knowledge-base status

X

Patch a knowledge-base by uploading documents, or providing a external vector index

X

Create a knowledge-base by uploading documents, or providing a external vector index

X

Delete a KB and ingested documents by ID

X

Delete some ingested documents from a knowledge-base

X

Fetch knowledge-bases

X

Get a KB by ID

X

Ingest additional documents into a knowledge-base

X

Knowledge-base status

X

Patch a knowledge-base by uploading documents, or providing a external vector index

X

Merge schema

Delete the request

X

Get the results of the request

X

Retrieve the merge schema requests

X

Start a merge schema request

X

Message threads

Add messages to a specific thread

X

Create a message thread

X

Delete message thread

X

Delete messages to a specific thread

X

Get messages to a specific thread

X

Get messages to a specific thread

X

List all threads by ID

X

List message threads

X

Update message thread

X

Update messages to a specific thread

X

Add messages to a specific thread

X

Create a message thread

X

Delete message thread

X

Delete messages to a specific thread

X

Get messages to a specific thread

X

Get messages to a specific thread

X

List all threads by ID

X

List message threads

X

Update message thread

X

Update messages to a specific thread

X

Model gateway (Preview)

Create backend

X

Create chat completions

X

Create embeddings

X

Create image generations

X

Create load balancer

X

Create new Anthropic provider

X

Create new AWS bedrock provider

X

Create new Azure OpenAI provider

X

Create new Cerebras provider

X

Create new Gemini provider

X

Create new Groq provider

X

Create new IBM WatsonXAI provider

X

Create new model

X

Create new NVIDIA NIM provider

X

Create new OpenAI provider

X

Create new policy

X

Create rate limit configuration

X

Create text completions

X

Delete current tenant

X

Delete existing model

X

Delete existing model

X

Delete existing policy

X

Delete existing provider

X

Delete load balancer backend

X

Delete load balancer

X

Delete rate limit configuration

X

Find existing providers

X

Get current tenant

X

Get existing model

X

Get existing provider

X

Get load balancer backend

X

Get load balancer

X

Get rate limit configuration

X

List all models

X

List all policies

X

List all providers

X

List available models

X

List backends

X

List load balancers

X

List provider models

X

List rate limit configurations

X

Replace current tenant

X

Replace existing Anthropic provider

X

Replace existing AWS bedrock provider

X

Replace existing Azure OpenAI provider

X

Replace existing Cerebras provider

X

Replace existing Gemini provider

X

Replace existing Groq provider

X

Replace existing IBM watsonxai provider

X

Replace existing model

X

Replace existing NVIDIA NIM provider

X

Replace existing OpenAI provider

X

Replace load balancer backend

X

Replace rate limit configuration

X

Update current tenant

X

Update existing model

X

Update load balancer

X

Validate provider credentials

X

Model policy

Create model policy

X

Delete model policy by ID

X

List model policies

X

Update model

X

Create model policy

X

Delete model policy by ID

X

List model policies

X

Update model

X

Models

Create an LLM model

X

List available embedding models

X

List LLM models

X

Create an LLM model

X

List available embedding models

X

List LLM models

X

Notebook versions

Create a new version

X

Delete a notebook version

X

List the versions of a notebook

X

Retrieve a notebook version

X

Notebooks

Create a new notebook

X

Delete a particular notebook, including the notebook asset

X

Retrieve the details of a large number of notebooks inside a project

X

Revert the main notebook to a version

X

Update a particular notebook

X

Orchestrate agent

Chat with orchestrate

X

Generate chat completions for a specific orchestrate entity

X

Get details for a specific run

X

List all orchestrate runs

X

List events for a specific run

X

Start or interact with run stream

X

Upload to S3

X

Chat with orchestrate

X

Generate chat completions for a specific orchestrate entity

X

Get details for a specific run

X

List all orchestrate runs

X

List events for a specific run

X

Start or interact with run stream

X

Upload to S3

X

Prompt sessions

Add a new chat item to a prompt session entry

X

Add a new prompt to a prompt session

X

Create a new prompt session

X

Delete a prompt session

X

Delete a prompt session entry

X

Get a prompt session entry

X

Get a prompt session

X

Get current prompt session lock status

X

Get entries for a prompt session

X

Prompt session lock modifications

X

Update a prompt session

X

Prompts

Add a new chat item to a prompt

X

Create a new prompt/prompt template

X

Delete a prompt

X

Get a prompt

X

Get current prompt lock status

X

Get the inference input string for a given prompt

X

Prompt lock modifications

X

Update a prompt

X

Skill sets

Get a list of skill sets

X

Get a list of skills for a skill set

X

Skills

Get an OpenAPI specification of a skill

X

Use a skill based on delete method

X

Use a skill based on get method

X

Use a skill based on patch method

X

Use a skill based on post method

X

Use a skill based on put method

X

Synthetic data

Create a synthetic unstructured data generation job

X

Synthetic data generation (Beta)

Cancel the synthetic data generation

X

Create a synthetic data generation job

X

Get synthetic data generation job

X

Get synthetic data generation jobs

X

Taxonomy (Beta)

Cancel or delete the taxonomy job

X

Create a taxonomy job

X

Get taxonomy job

X

Get taxonomy jobs

X

Text chat

Chat completions

X

Infer text event stream

X

Infer text

X

Text classification

Delete the request

X

Get the results of the request

X

Retrieve the text classification requests

X

Start a text classification request

X

Text detection

Detection task on input content based on context documents

X

Detection task performing detection on prompt and generated text

X

Hap and pii detection for text

X

Text embeddings

Detect text similarities

X

Generate embeddings

X

Text extraction

Delete the request

X

Get the results of the request

X

Retrieve the text extraction requests

X

Start a text extraction request

X

Text generation

Infer text event stream

X

Infer text

X

Text rerank

Generate rerank

X

Text to image

Create an image

X

Text tokenization

Text tokenization

X

Time series

Time series forecast

X

Toolkits

Create a toolkit

X

Delete a toolkit by ID

X

Download files from a toolkit

X

Get toolkit by ID

X

List toolkits

X

Prepare or list tools for toolkit

X

Upload files for a toolkit

X

Create a toolkit

X

Delete a toolkit by ID

X

Download files from a toolkit

X

Get toolkit by ID

X

List toolkits

X

Prepare or list tools for toolkit

X

Upload files for a toolkit

X

Tools

Create a tool

X

Delete a tool by ID

X

Download content from a specific tool

X

Get tool by ID

X

List tools

X

Patch a tool

X

Upload content for a specific tool

X

Create a tool

X

Delete a tool by ID

X

Download content from a specific tool

X

Get tool by ID

X

List tools

X

Patch a tool

X

Upload content for a specific tool

X

Trace search

Get all spans for a given trace ID

X

Search traces with filters

X

Get all spans for a given trace ID

X

Search traces with filters

X

Trainings

Cancel or delete the training

X

Create a new WatsonXAI training

X

Retrieve the list of trainings

X

Retrieve the training

X

Utility agent tools (Beta)

Get utility agent tool

X

Get utility agent tools

X

Run a utility agent tool

X

Run a utility agent tool

X

Vector indexes

Create a vector index

X

Delete a vector index

X

Get a vector index

X

Update a vector index

X

Vector index attachments modifications

X

Vector indexes: Transactional API

Create a vector index

X

Get status of a vector index

X

Update a vector index

X

Voice configurations

Create voice configuration

X

Delete voice configuration

X

Get voice configuration by ID

X

List voice configurations

X

Update voice configuration

X

Create voice configuration

X

Delete voice configuration

X

Get voice configuration by ID

X

List voice configurations

X

Update voice configuration

X

Watsonx assistant

List all external chat agent

X

Register a specific external chat agent

X

List all external chat agent

X

Register a specific external chat agent

X

Welcome content

Create or update welcome content

X

Delete welcome content

X

Get welcome content

X

Create or update welcome content

X

Delete welcome content

X

Get welcome content

X