IBM watsonx integration

AI platform: text generation, embeddings, models, deployments, prompt templates

Help CentreConnectors

Overview

IBM watsonx is IBM's enterprise AI platform – text generation, embeddings, custom model deployments, prompt templates. The Automize watsonx connector covers AI inference + deployment operations.

  • Regions: IBM Cloud regions.
  • Plans: Per-model + per-RU pricing.

Setting up the connection

Auth type: Bearer Token.

  1. IBM Cloud → IAM → API key.
  2. Exchange API key for IAM bearer token (connector handles).
  3. In Automize → Settings → Connectors → IBM watsonx. Paste API key + project ID.

Find your credentials at https://cloud.ibm.com/iam/apikeys.


Rate limits

Per-instance + per-model.


Data model

AI primitives:

    Project ─┬─ Models (foundation + custom)
             ├─ Deployments
             ├─ Prompt Templates
             └─ Embeddings index

Available operations

16 operations available. Click any row to jump to its detail.

OperationCategoryWhat it does
Cancel Training JobGeneralCancel a training job
Create DeploymentGeneralCreate a model deployment
Create Prompt TemplateGeneralCreate a prompt template
Create Training JobGeneralCreate a training/tuning job
Delete DeploymentGeneralDelete a deployment
Generate EmbeddingsGeneralGenerate text embeddings
Generate TextGeneralGenerate text from a foundation model
Generate Text (Stream)GeneralGenerate text with streaming response
Get DeploymentGeneralGet deployment details
Get ModelGeneralGet model details
Get Training JobGeneralGet training job details
List DeploymentsGeneralList model deployments
List ModelsGeneralList available foundation models
List Prompt TemplatesGeneralList saved prompt templates
List Training JobsGeneralList training/tuning jobs
TokenizeGeneralTokenize text for a model

Operations

Cancel Training Job

Cancel a training job

ParameterRequiredTypeDescription
Training Id training_idYestext

Create Deployment

Create a model deployment

No input parameters.


Create Prompt Template

Create a prompt template

No input parameters.


Create Training Job

Create a training/tuning job

No input parameters.


Delete Deployment

Delete a deployment

ParameterRequiredTypeDescription
Deployment Id deployment_idYestext

Generate Embeddings

Generate text embeddings

ParameterRequiredTypeDescription
Model Id model_idNotext
Inputs inputsNotext
Project Id project_idNotext

Generate Text

Generate text from a foundation model

ParameterRequiredTypeDescription
Model Id model_idNotext
Input inputNotext
Parameters parametersNotext
Project Id project_idNotext

Generate Text (Stream)

Generate text with streaming response

ParameterRequiredTypeDescription
Model Id model_idNotext
Input inputNotext
Parameters parametersNotext
Project Id project_idNotext

Get Deployment

Get deployment details

ParameterRequiredTypeDescription
Deployment Id deployment_idYestext

Get Model

Get model details

ParameterRequiredTypeDescription
Model Id model_idYestext

Get Training Job

Get training job details

ParameterRequiredTypeDescription
Training Id training_idYestext

List Deployments

List model deployments

No input parameters.


List Models

List available foundation models

No input parameters.

Tips

  • Returns foundation models + your custom-trained deployments.

List Prompt Templates

List saved prompt templates

No input parameters.

Tips

  • Reusable prompt configurations.

List Training Jobs

List training/tuning jobs

No input parameters.


Tokenize

Tokenize text for a model

ParameterRequiredTypeDescription
Model Id model_idNotext
Input inputNotext
Parameters parametersNotext
Project Id project_idNotext

FAQ

vs OpenAI / Anthropic?
watsonx: IBM-supported, enterprise-grade, on-prem option, multiple model providers (Meta Llama, Mistral, IBM Granite). OpenAI/Anthropic: best-in-class quality on flagship models.

Related connectors

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.