Available APIs

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

IBM® Software Hub and some services that run on the platform provide open and extensible APIs.

You can authenticate to the IBM Software Hub platform and the APIs by using a single authentication token. See Generating API keys for authentication.

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

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 IBM Software Hub, 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 the Analytics Engine powered by Apache Spark service on the IBM Software Hub 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

Connections API

Description
The Data and AI Common Core 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:

  • IBM Knowledge Catalog
  • Watson Studio
  • A service that installs the IBM Software Hub common core services. The common core services are automatically installed by services that rely on them.
API reference
Data and AI Common Core Software APIs

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

Data and AI Common Core API

Description
You can use the Data and AI Common Core API for software products such as IBM Cloud Pak® for Data and IBM watsonx™. For example, you can use the API to perform the following tasks.
  • Manage projects.
  • Manage connections in projects.
  • Discover assets from a connection.
  • Manage jobs and environments.
  • Execute queries in global search.
Requirements

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

API reference
Data and AI Common Core Software APIs

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 IBM Software Hub platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference
Data Gate 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 IBM Software Hub 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 IBM Software Hub 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 IBM Software Hub 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 IBM Software Hub platform.
API reference
Decision Optimization Python client

IBM Knowledge Catalog API

Description

The IBM Knowledge Catalog 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.

  • Define data profiling.
  • Analyze data quality.
  • Establish a business glossary.
  • Create metadata discovery and enrichment assets.
  • Define data governance policies.
  • Manage data governance workflows.
Requirements

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

API reference
IBM Knowledge Catalog software APIs
You can also use the Data and AI Common Core API to manage data-related assets in IBM Knowledge Catalog.

IBM Manta Data Lineage API

Description

The IBM Manta Data Lineage API provides capabilities to manage your data lineage. For example, you can use the API to mange the following areas.

  • Lineage assets
  • Lineage graph
  • Technology
  • Licensing
Requirements

To use this API, the IBM Manta Data Lineage service must be installed.

API reference
IBM Manta Data LineageAPI reference

IBM Match 360 API

Description
Use the IBM Match 360 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 service must be installed.
API reference
IBM Match 360 with Watson API reference

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

Deprecated Watson Data for IBM Cloud Pak for Data API

Watson Data for IBM Cloud Pak for Data API documentation is deprecated and might be out of date.

Use the following APIs:

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 by using tools that include 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 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