Skip to content
To Comet website
Doc version: 3.13.98

Overview

Comet Javascript SDK for REST API

This page describes the Comet Javascript SDK Library.

Javascript REST API

To use the Javascript REST API, you will need to load the Comet Javascript SDK library. For example, in HTML:

<script src="https://cdn.comet.ml/js/comet-javascript-sdk-1.1.24.js">
</script>

You will then need to create an instance of the Comet.API class, like this:

const api = new Comet.API("COMET_REST_API_KEY");

Note: all of the following methods return a Promise rather than the actual value. For explanation utility, we simply say that a method "returns" a value. In reality, you will need to handle the promise with .then() or with await.

Workspace, Projects, and Experiments

  • Comet.API.get(): returns workspace names
  • Comet.API.get("workspace"): returns project names
  • Comet.API.get("workspace/project"): returns experiment keys
  • Comet.API.get("workspace/project/experiment"): returns experiment JSON
  • Comet.API.experimentsByProjectId(projectId): returns Project JSON
  • Comet.API.experimentsByProjectName(workspace, project): returns Project JSON

Metrics

  • Comet.API.experimentMetricsRaw(experimentKey): returns Promise with raw JSON of all metrics
  • Comet.API.experimentMetricsRaw(experimentKey, "acc"): returns Promise with JSON of metric "acc"
  • Comet.API.experimentMetricsRaw(experimentKey, ["acc"]): returns Promise with JSON of metric "acc"
  • Comet.API.experimentMetricsRaw(experimentKey, ["acc"], "timestamp"): returns Promise with JSON of metric "acc" with xAxis as date (default xAxis is "step")
  • Comet.API.experimentMetrics(experimentKey):
  • Comet.API.experimentMetrics(experimentKey, metricName):

Parameters

  • Comet.API.experimentParameters(experimentKey):
  • Comet.API.experimentParameters(experimentKey, parameterName):
  • Comet.API.experimentParameters(experimentKey, parameterName, property):

Other

  • Comet.API.experimentOther(experimentKey):
  • Comet.API.experimentOther(experimentKey, other):
  • Comet.API.experimentOther(experimentKey, other, value):

Assets and Misc

  • Comet.API.experimentAssets(experimentKey):
  • Comet.API.experimentAsset(experimentKey, assetId):
  • Comet.API.experimentAsset(experimentKey, assetId, returnType):
  • Comet.API.experimentAssetByName(experimentKey, fileName, 'json'): returns Promise with asset with fileName, as JSON

Images

  • Comet.API.experimentImages(experimentKey): returns list of image JSONs
  • Comet.API.experimentImageByName(experimentKey, figName):

Experiment Data

  • Comet.API.experimentName(experimentKey): returns Promise with name
  • Comet.API.experimentHtml(experimentKey): returns HTML
  • Comet.API.experimentCode(experimentKey): returns Code
  • Comet.API.experimentStdout(experimentKey): returns stdout
  • Comet.API.experimentInstalledPackages(experimentKey): returns list of Python installed packages
  • Comet.API.experimentGraph(experimentKey): returns model graph, as string

Workspace and Project Methods

  • Comet.API.projects(workspace): returns Promise with project JSONs
  • Comet.API.get(): returns workspace names
  • Comet.API.get("workspace"): returns project names
  • Comet.API.get("workspace/project"): returns experiment keys
  • Comet.API.get("workspace/project/experimentKey"): returns experiment JSON
Nov. 5, 2025