Experiment APIs

APIs for tracking and analytics of experiments

List all experiments for a project.

get

Retrieves a paginated list of experiments associated with the specified project ID. This endpoint is accessible to authenticated users and is intended for tracking and analytics purposes. Use the 'start' and 'limit' parameters to control pagination.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Query parameters

startinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 1024

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/experiments

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/experiments HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "tags": [
      "text"
    ],
    "creation_date": "2025-12-16T22:08:17.734Z",
    "start_date": "2025-12-16T22:08:17.734Z",
    "stop_date": "2025-12-16T22:08:17.734Z",
    "description": "text",
    "media": {
      "hero_image_url": "text"
    },
    "status": "published",
    "owner": "text",
    "project_id": "text",
    "org_id": "text",
    "external_id": "text",
    "external_source": "text",
    "scopes": [
      {
        "id": "text"
      }
    ],
    "privacy_url": "text",
    "tos_url": "text",
    "info_url": "text"
  }
]

Create a new experiment for tracking.

post

This endpoint allows users to create an experiment within a specified project. The created experiment can be utilized for tracking and analytics purposes. Ensure that the provided experiment data adheres to the required format for successful creation.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Body

application/json

idstringOptional

namestringOptional

tagsstring[]Optional

creation_datestring · date-timeOptional

start_datestring · date-timeOptional

stop_datestring · date-timeOptional

descriptionstringOptional

statusstring · enumOptionalPossible values:

ownerstringOptional

project_idstringOptional

org_idstringOptional

external_idstringOptional

external_sourcestringOptional

privacy_urlstringOptional

tos_urlstringOptional

info_urlstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/console/projects/{projectId}/experiments

HTTPcURLJavaScriptPython

POST /console/projects/{projectId}/experiments HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 419

{
  "id": "text",
  "name": "text",
  "tags": [
    "text"
  ],
  "creation_date": "2025-12-16T22:08:17.734Z",
  "start_date": "2025-12-16T22:08:17.734Z",
  "stop_date": "2025-12-16T22:08:17.734Z",
  "description": "text",
  "media": {
    "hero_image_url": "text"
  },
  "status": "published",
  "owner": "text",
  "project_id": "text",
  "org_id": "text",
  "external_id": "text",
  "external_source": "text",
  "scopes": [
    {
      "id": "text"
    }
  ],
  "privacy_url": "text",
  "tos_url": "text",
  "info_url": "text"
}

{
  "id": "text",
  "name": "text",
  "tags": [
    "text"
  ],
  "creation_date": "2025-12-16T22:08:17.734Z",
  "start_date": "2025-12-16T22:08:17.734Z",
  "stop_date": "2025-12-16T22:08:17.734Z",
  "description": "text",
  "media": {
    "hero_image_url": "text"
  },
  "status": "published",
  "owner": "text",
  "project_id": "text",
  "org_id": "text",
  "external_id": "text",
  "external_source": "text",
  "scopes": [
    {
      "id": "text"
    }
  ],
  "privacy_url": "text",
  "tos_url": "text",
  "info_url": "text"
}

Retrieve a specific experiment by ID

get

This endpoint returns the details of a specified experiment within a project. It requires the project ID and experiment ID as path parameters. Ensure you have the necessary permissions to access this experiment.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

experimentIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/projects/{projectId}/experiments/{experimentId}

HTTPcURLJavaScriptPython

GET /console/projects/{projectId}/experiments/{experimentId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "tags": [
    "text"
  ],
  "creation_date": "2025-12-16T22:08:17.734Z",
  "start_date": "2025-12-16T22:08:17.734Z",
  "stop_date": "2025-12-16T22:08:17.734Z",
  "description": "text",
  "media": {
    "hero_image_url": "text"
  },
  "status": "published",
  "owner": "text",
  "project_id": "text",
  "org_id": "text",
  "external_id": "text",
  "external_source": "text",
  "scopes": [
    {
      "id": "text"
    }
  ],
  "privacy_url": "text",
  "tos_url": "text",
  "info_url": "text"
}

Update an existing experiment in the project.

put

This endpoint allows you to update the details of a specified experiment within a given project. Ensure that the experiment ID and project ID are correctly provided. This operation requires appropriate authentication and authorization.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

experimentIdstringRequired

Body

application/json

idstringOptional

namestringOptional

tagsstring[]Optional

creation_datestring · date-timeOptional

start_datestring · date-timeOptional

stop_datestring · date-timeOptional

descriptionstringOptional

statusstring · enumOptionalPossible values:

ownerstringOptional

project_idstringOptional

org_idstringOptional

external_idstringOptional

external_sourcestringOptional

privacy_urlstringOptional

tos_urlstringOptional

info_urlstringOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/projects/{projectId}/experiments/{experimentId}

HTTPcURLJavaScriptPython

PUT /console/projects/{projectId}/experiments/{experimentId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 419

{
  "id": "text",
  "name": "text",
  "tags": [
    "text"
  ],
  "creation_date": "2025-12-16T22:08:17.734Z",
  "start_date": "2025-12-16T22:08:17.734Z",
  "stop_date": "2025-12-16T22:08:17.734Z",
  "description": "text",
  "media": {
    "hero_image_url": "text"
  },
  "status": "published",
  "owner": "text",
  "project_id": "text",
  "org_id": "text",
  "external_id": "text",
  "external_source": "text",
  "scopes": [
    {
      "id": "text"
    }
  ],
  "privacy_url": "text",
  "tos_url": "text",
  "info_url": "text"
}

{
  "id": "text",
  "name": "text",
  "tags": [
    "text"
  ],
  "creation_date": "2025-12-16T22:08:17.734Z",
  "start_date": "2025-12-16T22:08:17.734Z",
  "stop_date": "2025-12-16T22:08:17.734Z",
  "description": "text",
  "media": {
    "hero_image_url": "text"
  },
  "status": "published",
  "owner": "text",
  "project_id": "text",
  "org_id": "text",
  "external_id": "text",
  "external_source": "text",
  "scopes": [
    {
      "id": "text"
    }
  ],
  "privacy_url": "text",
  "tos_url": "text",
  "info_url": "text"
}

Delete a specified experiment from the project.

delete

This endpoint allows users to delete an experiment identified by its ID within a specific project. It ensures that only authorized users can perform this action, maintaining the integrity of the experiment tracking system. Use this operation to manage experiments effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

experimentIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/console/projects/{projectId}/experiments/{experimentId}

HTTPcURLJavaScriptPython

DELETE /console/projects/{projectId}/experiments/{experimentId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content