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 REST APIs, you can complete the following tasks.

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

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

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

IBM Cloud Pak for Data platform API

Description

The IBM 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 IBM Cloud Pak for Data platform.

Requirements

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

API reference

IBM Cloud Pak for Data Platform API

Apache Spark jobs API

Description

In IBM Cloud Pak for Data, you can run Spark jobs or applications on your IBM Cloud Pak for Data cluster without installing Watson™ Studio by using the Spark jobs REST APIs 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 IBM 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 and images APIs

Description: Use Cognos Analytics APIs to manage artifacts that are used in Cognos Analytics reports, dashboards, and other features.
Requirements: To use these APIs, an administrator must install this service on the IBM 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: Managing artifacts and images with the Cognos Analytics APIs

DataStage REST APIs

Description: Use a collection of DataStage REST APIs to process, compile, and run flows. DataStage flows are design-time assets that contain data integration logic in JSON-based schemas.
Requirements: To use these APIs, an administrator must install this service on the IBM 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 APIs

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. Additionally, by using the Data Virtualization REST API, you can virtualize and publish data to the default catalog in Watson Knowledge Catalog.
Requirements: To use this API, an administrator must install this service on the IBM 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 REST 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 IBM 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

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 APIs

Description

The OpenPages APIs provide access to OpenPages data and metadata. You can use the APIs to develop solutions that extend the application.

Requirements

To use these APIs, the OpenPages service must be installed.

API reference

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 APIs 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 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 APIs

Watson Assistant API and SDKs

Description

The Watson 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 Watson Assistant service must be installed.

API reference

Learn more

See Building an assistant with Watson Assistant.

Watson Data API

Description

The Watson Data API provides collect and organize capabilities. 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 following services must be installed:

Watson Knowledge Catalog
Watson Studio

API reference

Watson Data API

Watson Data API for connections

Description

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

Requirements

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

Watson Knowledge Catalog
Watson Studio

API reference

Watson Data API for connections

Watson Discovery API and SDKs

Description

The Watson Discovery APIs provide 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 also surface information that Watson Discovery unearths in Watson Assistant.

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 Knowledge Catalog Factsheet Service APIs

Description

The Watson Knowledge Catalog Factsheet Service APIs provide methods for you to view models that are in production and manage models that need development or validation in your model inventory.

Requirements

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

API reference

Watson Knowledge Catalog Factsheet Service: Use the Watson Knowledge Catalog Factsheet Service APIs 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.

Watson Machine Learning APIs

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 analytical models and neural networks.
Deploy your analytical models and neural networks for use in other 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 APIS to interact with your machine learning assets.
Watson Machine Learning Python client: Use the Watson Machine Learning Python client to build, train, and deploy models and functions and run scripts.

Watson OpenScale API

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.

Requirements

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

API reference

Watson OpenScale API

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.