Back to Mastra

Reference: dataset.getExperiment() | Datasets

docs/src/content/en/reference/datasets/getExperiment.mdx

2025-12-18871 B
Original Source

dataset.getExperiment()

Added in: @mastra/[email protected]

Retrieves a specific experiment (run) by its ID.

Usage example

typescript
import { Mastra } from '@mastra/core'

const mastra = new Mastra({
  /* storage config */
})

const dataset = await mastra.datasets.get({ id: 'dataset-id' })

const experiment = await dataset.getExperiment({ experimentId: 'exp-id' })

console.log(`Status: ${experiment.status}`)
console.log(`${experiment.succeededCount}/${experiment.totalItems} succeeded`)

Parameters

<PropertiesTable content={[ { name: 'experimentId', type: 'string', description: 'ID of the experiment to retrieve.', }, ]} />

Returns

<PropertiesTable content={[ { name: 'result', type: 'Promise<Experiment>', description: 'The experiment record. See dataset.listExperiments() for the full shape.', }, ]} />