Available APIs

The APIs that you have access to depend on the services that are installed in your environment.

IBM Cloud Pak for Data and some services that run on the platform provide open and extensible APIs that you can use to collect, organize, and analyze your data and to infuse your applications with AI. With this collection of APIs, you can complete the following tasks.

Automate and govern your AI lifecycle in business applications so that you can use AI.
Implement data-driven processes and operations that feed your AI and ML applications.

You can authenticate to the Cloud Pak for Data platform and the APIs by using a single authentication token. See Generating an API authorization token.

For more information about the APIs that you can use, see the following resources.

Cloud Pak for Data platform API

Description

The Cloud Pak for Data Platform API is an administration API that you can use to perform the following tasks.

Authenticate to the platform.
Manage the users who have access to the platform.
Manage the roles that are defined on the platform.
Update your user account on the platform.
Monitor the status of the Cloud Pak for Data platform.

The Cloud Pak for Data Platform API was updated for Cloud Pak for Data version 5.0.0. This API applies to Cloud Pak for Data version 5.0.0 and all subsequent versions of Cloud Pak for Data until a new version of the API is created.

Requirements

To use this API, the Cloud Pak for Data control plane must be installed.

API reference

Service instance API: Create, retrieve, and delete service instances if you are a Cloud Pak for Data administrator with the Create service instances permission.
Alerting API: Use the Alerting API to browse generated events and also to configure monitors and alerts.
Home page custom card API: Create custom cards to display key performance indicators on the Cloud Pak for Data home page with the Custom cards REST API.
Vaults and secrets API: Safeguard credentials and secrets with access control and audit logging by using the Vaults and secrets API.
Volumes API: Create and manage persistent volume instances on your existing Cloud Pak for Data storage devices with the Volumes REST API.

Cloud Pak for Data Instance Management APIs

Description

Use the IBM Cloud Pak for Data Instance Management REST APIs to set up and manage an instance of Cloud Pak for Data. You can perform the following tasks by using this API:

Install and upgrade an instance of Cloud Pak for Data: A cluster admin can install and upgrade an instance of Cloud Pak for Data.
Get the status of an instance of Cloud Pak for Data: A cluster admin can get the status of installed components in an instance of Cloud Pak for Data.
Shut down and restart an instance of Cloud Pak for Data: A cluster admin can shut down and restart installed components in an instance of Cloud Pak for Data.

Requirements

To use this API, you must be a cluster administrator.

API Reference

IBM Cloud Pak for Data Instance Management REST APIs

AI Factsheets API

Description

Use AI Factsheets API to create model use cases, control model tracking, get the model facts, and get information about alerts on the deployed tracked models.

Requirements

To use this API, the AI Factsheets service must be installed.

API reference

Factsheet Service: Use the AI Factsheets API to interact with your model inventory.
IBM AI Governance Facts Client Python library: Collect facts on different experiments that are run within Jupyter Notebooks either in IBM Cloud, external machine learning engines, or stand-alone environments.

Apache Spark jobs API

Description

In Cloud Pak for Data, you can run Spark jobs or applications on your cluster without installing Watson Studio. Use the Spark jobs REST API of Analytics Engine powered by Apache Spark.

You can submit any Spark application that runs Spark SQL or data transformation, data science, and machine learning jobs by using the Spark jobs REST API. Each submitted job runs in a dedicated cluster.

Requirements

To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.

API reference

Spark jobs API syntax, parameters and return codes

Cognos Analytics artifacts API

Description: Use Cognos Analytics API to manage artifacts that are used in Cognos Analytics reports, dashboards, and other features.
Requirements: To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference: Cognos Analytics Artifacts API

Connections API

Description

The Watson Data API includes instructions for creating a connection in a catalog or project.

Requirements

To use this API, one of the following services must be installed:

Common core services or a service that installs the common core services. For more information, see Software requirements.
IBM Knowledge Catalog
Watson Studio

API reference

Connections in the Watson Data API.

You can view a table of the individual data source properties at Data > Connectivity. Expand Connection resources, and select Connection properties.

Data Gate API

Description: You can use application programming interfaces (APIs) to allow apps to communicate with Data Gate.
Requirements: To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference: Data Gate API

Data Product Hub API

Description: You can use application programming interfaces (APIs) to work with data products in Data Product Hub.
Requirements: To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference: Data Product Hub API

DataStage REST API

Description: Use the DataStage REST API to process, compile, and run flows. DataStage flows are design-time assets that contain data integration logic in JSON-based schemas.
Requirements: To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference: DataStage REST API

Data Virtualization REST API

Description: The Data Virtualization REST API connects to your service deployment so that you can manage your virtual data, data sources, and user roles. Also, by using the Data Virtualization REST API, you can virtualize and publish data to the default catalog in IBM Knowledge Catalog.
Requirements: To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference: Data Virtualization REST API

Db2 Data Management Console API

Description: The Db2 Data Management Console REST API connects to your service deployment so that you can monitor your data and data sources.
Requirements: To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference: Db2 Data Management Console REST API

Decision Optimization Python client

Description

You can interact with Decision Optimization experiments by using the Decision Optimization client API. You can perform the following tasks.

Create and run multiple scenarios of Decision Optimization experiments with different data or model formulations.
Obtain solution results.

Requirements

To use this API, an administrator must install the Decision Optimization service on the Cloud Pak for Data platform.

API reference

Decision Optimization Python client

IBM Match 360 with Watson API

Description

Use the IBM Match 360 with Watson API to connect its powerful master data matching capabilities to your systems and processes. Use the API and corresponding SDKs to develop applications that interact with the service.

Configure master data.: Configure the data model, manage project metadata, suggest mapping and matching attributes, and initiate the data matching process.
View and change master data.: Search for and modify the data in the system. Use the API to search, view, edit, and export records and entities.
Match data.: Manage the data matching process by initiating matching and visualizing matching results and master data entities.
Manage the data model.: Manage the metadata in the IBM Match 360 system. Use the API to view and modify the model, the matching algorithm, and the composite view rules.

Requirements

To use this API, the IBM Match 360 with Watson service must be installed.

API reference

IBM® Match 360 with Watson™ API reference

Learn more

See Managing master data.

OpenPages API

Description: The OpenPages API provides access to OpenPages data and metadata. You can use the API to develop solutions that extend the application.
Requirements: To use this API, the OpenPages service must be installed.
API reference: OpenPages Developer Guide

Orchestration Pipelines API and SDKs

Description

Currently, Orchestration Pipelines offers a Python client API only. Use the API to query data, expose outputs, and more.

Requirements

To use this API, the Orchestration Pipelines service must be installed.

API reference

Planning Analytics TM1 REST API

Description: Use Planning Analytics TM1 REST API to perform create, read, update, and delete operations on TM1 data. The TM1 REST API provides an Open Data Protocol (OData) Version 4 compliant interface to a TM1 server, which allows clients to query and update data sources that are hosted on the TM1 server.
Requirements: To use this API, an administrator must install this service on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference: TM1 REST API

Product Master API

Description

Product Master provides REST API layer to access and manage master data and related entities. A complete REST API definition is available to use as an OpenAPI Specification. REST API can be used for integration with various upstream and downstream systems and to create or retrieve content from the Product Master.

You can use the Product Master REST API to perform the following tasks.

Create and enrich master data. For example, products, locations, vendors, or customers.
Categorize master data into domain-specific taxonomies.
Search and view master data.
Create and manage a data model. For example, specifications, catalogs, or scheduled jobs.
Manage reference data. For example, taxonomies or lookups.
Generate reports and collect audit information.
Upload digital assets and manage linking to the master data.

Requirements

To use this API, the Product Master service must be installed.

API reference

Product Master REST API

Watson Data API for IBM Knowledge Catalog

Description

The Watson Data API provides capabilities for IBM Knowledge Catalog. You can use the API to manage data-related assets and the people who need to use these assets. For example, you can use the API to perform the following tasks.

Manage analytics projects.
Manage catalogs.
Manage the connections that are available to analytics projects and to catalogs.
Manage governance policies.
Discover assets from a connection.
View the lineage of an asset.

Requirements

To use this API, the IBM Knowledge Catalog service must be installed:

API reference

Watson Data API

Watson Data API for Watson Studio

Description

The Watson Data API provides capabilities for Watson Studio. You can use the API to manage data-related assets and the people who need to use these assets. For example, you can use the API to perform the following tasks.

Manage analytics projects.
Manage catalogs.
Manage the connections that are available to analytics projects and to catalogs.
Manage governance policies.
Discover assets from a connection.
View the lineage of an asset.

Requirements

To use this API, the Watson Studio service must be installed:

API reference

Watson Data API

Watson Discovery API and SDKs

Description

The Watson Discovery API provides an AI-powered search engine that you can use to extract answers from complex business documents.

You can enhance the ability of Watson Discovery to understand domain-specific language with the Watson Knowledge Studio service.

You can surface information that Watson Discovery unearths in watsonx Assistant.

You can also use Cloud Pak for Data REST API to create a Watson Discovery service instance. For more information, see Creating a Watson Discovery service instance programmatically.

Requirements

To use this API, the Watson Discovery service must be installed.

API reference

Discovery v2 API

Learn more

See Finding answers with Watson Discovery.

Watson Machine Learning API

Description

You can train, store, deploy, and score models and functions by using the Watson Machine Learning API or Python client library. You can perform the following tasks.

Build and train AI assets using tools including AutoAI, Federated Learning, or Prompt Lab.
Deploy and score AI assets and manage deployments.
Get endpoints for deployed assets to use in applications.

Requirements

To use this API, the Watson Machine Learning service must be installed.

API reference

Watson Machine Learning API: Use the Watson Machine Learning REST API to interact with your machine learning assets.
watsonx.ai Python client library: Use the watsonx.ai Python client library library for working with traditional machine learning and generative AI assets.
Deprecated Watson Machine Learning Python client library: The Watson Machine Learning Python client library is now part of the watsonx.ai Python client library. The Watson Machine Learning library is still available but it is not updated with new features.

Watson OpenScale API and SDK

Description

The Watson OpenScale API provides infuse capabilities. You can use the API to perform the following tasks.

Measure the outcomes of your AI models.
Ensure that your models are fair.
Ensure that your models are explainable.

You can also use the Watson OpenScale Python SDK to connect to your training data to evaluate batch deployments.

Requirements

To use this API, the Watson OpenScale service must be installed.

API reference

Watson Speech services API and SDKs

Description

The Watson Speech services API and SDKs combine two Watson services. You can choose which services to install. You can combine the features from these services to build AI applications or to enhance your existing applications with AI.

Requirements

To use this API, the Watson Speech services service must be installed.

API reference

Learn more

See Transcribing speech with Watson Speech services.

watsonx.ai API and SDKs

Description

You can inference and tune foundation models by using the watsonx.ai API or client libraries.

Requirements

To use the watsonx.ai API, the watsonx.ai service must be installed.

API reference

watsonx.ai API: Use the REST API to develop generative AI solutions.
watsonx.ai Python library: Use notebooks to develop generative AI solutions.
watsonx.ai Node.js SDK: Use the client library to incorporate generative AI into your applications

Learn more

See Coding generative AI solutions.

watsonx Assistant API and SDKs

Description

The watsonx Assistant API provides infuse capabilities. You can use this API to build conversational interfaces into any app, device, or channel. The API combines machine learning and natural language understanding to deliver an engaging, unified problem-solving experience.

Requirements

To use this API, the watsonx Assistant service must be installed.

API reference

Learn more

See Building an assistant with watsonx Assistant.

watsonx.governance API and SDKs

Description

The watsonx.governance APIs extend AI Governance from predictive machine learning models to generative AI while monitoring and mitigating the risks associated with models, users, and data sets. The APIs combine AI Factsheets, Watson OpenScale, and OpenPages APIs and SDKs.

Requirements

To use this API, the watsonx.governance service must be installed.

API reference

Learn more

See Govern assets with watsonx.governance.