Sign in
Experiments

Start (or reuse) a TensorBoard for the experiment

Changed on
post/api/v1/experiments/{name}/tensorboard

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/experiments/{name}/tensorboard
  • Auth: none declared

Path parameters

namestring required

Headers

X-Axisml-Tenantstring

Active tenant for the request (fallback for the axisml.tenant cookie).

Request body

runsstring[]

Run names to scope the TensorBoard to; empty aggregates every Run of the experiment.

Example request

{
  "runs": [
    "bert-finetune-3",
    "bert-finetune-5"
  ]
}

Response

TensorBoard started.

createdAtstring date-time required

Time the TensorBoard was created.

messagestring

Human-readable status detail for the current phase.

namestring required

TensorBoard instance name.

phase'Pending' | 'Ready' | 'Failed' | 'Stopped'
urlstring

Endpoint URL for the TensorBoard UI once running.

Example response

{
  "createdAt": "2026-06-20T08:00:00Z",
  "message": "TensorBoard is serving.",
  "name": "bert-finetune-tb",
  "phase": "Running",
  "url": "https://tb.axisml.io/team-nlp/bert-finetune"
}

Changes

  • d51e2e0e6970Revision changes
    • breaking

      the response's property type changed from string to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      removed the Failed enum value from the response property for the response status

    • info

      removed the Pending enum value from the response property for the response status

    • info

      removed the Ready enum value from the response property for the response status

    • info

      removed the Stopped enum value from the response property for the response status