Skip to main content
GET
/
api
/
dataframer
/
runs
Python
import os
from dataframer import Dataframer

client = Dataframer(
    api_key=os.environ.get("DATAFRAMER_API_KEY"),  # This is the default and can be omitted
)
runs = client.dataframer.runs.list()
print(runs)
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "PENDING",
    "spec_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spec_name": "<string>",
    "spec_version": 123,
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_name": "<string>",
    "dataset_type": "SINGLE_FILE",
    "samples_completed": 123,
    "samples_failed": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "created_by_email": "<string>",
    "completed_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Response

List of runs

​
id
string<uuid>

Unique identifier for the run

​
status
enum<string>

Current status of the run

Available options:
PENDING,
PROCESSING,
SUCCEEDED,
FAILED,
CANCELED
​
spec_id
string<uuid>

ID of the spec used

​
spec_name
string

Name of the spec

​
spec_version
integer

Version number of the spec used

​
dataset_id
string<uuid> | null

ID of the seed dataset (null for seedless specs)

​
dataset_name
string | null

Name of the seed dataset (null for seedless specs)

​
dataset_type
enum<string>

Type of dataset

Available options:
SINGLE_FILE,
MULTI_FILE,
MULTI_FOLDER
​
samples_completed
integer

Number of samples successfully generated

​
samples_failed
integer

Number of samples that failed to generate

​
created_at
string<date-time>

When the run was created

​
created_by_email
string

Email of the user who created the run

​
completed_at
string<date-time> | null

When the run completed (null if not finished)