Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kubeflow Experiments API

Group runs and recurring jobs into logical experiments

Kubeflow Experiments API is one of 8 APIs that Kubeflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Experiments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 5 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2beta1.

Requests are made against a single base URL, https://{host}/pipeline.

5 operations 3 paths 2 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2beta1
Base URL
https://your-kubeflow-instance/pipeline
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Kubeflow Experiments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token issued by your Kubeflow distribution's identity provider. Some deployments use a session cookie instead.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Experiments 5

Group runs and recurring jobs into logical experiments

GET
/apis/v2beta1/experiments
List experiments
listExperiments 5 params → 200
POST
/apis/v2beta1/experiments
Create a new experiment
createExperiment body → 200
GET
/apis/v2beta1/experiments/{experiment_id}
Get experiment by ID
getExperiment 1 param → 200
DELETE
/apis/v2beta1/experiments/{experiment_id}
Delete experiment
deleteExperiment 1 param → 200
GET
/apis/v2beta1/runs
List pipeline runs
listRuns 4 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Experiment (6 properties), ListExperimentsResponse (3 properties). Each schema is shown below with its type and property counts.

Experiment
object
6 properties
ListExperimentsResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubeflow-experiments-api-openapi.yml Raw ↑

Other APIs Kubeflow publishes across the network.

Kubeflow Metadata API
Katib API
Kubeflow Notebooks API
Kubeflow Central Dashboard API
Kubeflow Health API
Kubeflow Pipelines API
Kubeflow PipelineVersions API