Skip to main content
POST
/
api
/
dataframer
/
runs
JavaScript
import Dataframer from 'dataframer';

const client = new Dataframer({
  apiKey: 'My API Key',
});

const run = await client.dataframer.runs.create({
  number_of_samples: 1,
  runtime_params: { foo: 'bar' },
  spec_version_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(run.spec_version_id);
{
  "spec_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "spec_id": "<string>",
  "spec_name": "<string>",
  "spec_version": 123,
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "dataset_type": "<string>",
  "number_of_samples": -1,
  "status": "PENDING",
  "status_display": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "runtime_params": {},
  "trace": {},
  "metrics_json": {},
  "created_by": 123,
  "created_by_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "duration_seconds": 123
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Body

application/json
spec_version_id
string<uuid>
required

ID of the spec version to use

number_of_samples
integer
required

Number of samples to generate

Required range: 1 <= x <= 500
runtime_params
object
required

Runtime parameters for generation (model, settings, etc.)

Response

Run created successfully

spec_version_id
string<uuid>
required
id
string<uuid>
spec_id
string
Minimum string length: 1
spec_name
string
Minimum string length: 1
spec_version
integer
dataset_id
string
Minimum string length: 1
dataset_name
string
Minimum string length: 1
dataset_type
string
Minimum string length: 1
number_of_samples
integer
Required range: -2147483648 <= x <= 2147483647
status
enum<string>
Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED,
CANCELED
status_display
string
Minimum string length: 1
started_at
string<date-time> | null
completed_at
string<date-time> | null
runtime_params
Runtime params · object
trace
Trace · object
metrics_json
Metrics json · object
created_by
integer | null
created_by_name
string
Minimum string length: 1
created_at
string<date-time>
duration_seconds
number