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)curl https://df-api.dataframer.ai/api/dataframer/runs/ \
-H "Authorization: Bearer $DATAFRAMER_API_KEY"[
{
"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,
"total_cost": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by_email": "<string>",
"completed_at": "2023-11-07T05:31:56Z"
}
]Data Generation Runs
List runs
Get all runs for the user’s company, ordered by creation time (newest first)
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)curl https://df-api.dataframer.ai/api/dataframer/runs/ \
-H "Authorization: Bearer $DATAFRAMER_API_KEY"[
{
"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,
"total_cost": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by_email": "<string>",
"completed_at": "2023-11-07T05:31:56Z"
}
]Authorizations
API Key authentication. Format: "Bearer YOUR_API_KEY"
Response
List of runs
Unique identifier for the run
Current status of the run
Available options:
PENDING, PROCESSING, SUCCEEDED, FAILED, CANCELED ID of the spec used
Name of the spec
Version number of the spec used
ID of the seed dataset (null for seedless specs)
Name of the seed dataset (null for seedless specs)
Type of dataset
Available options:
SINGLE_FILE, MULTI_FILE, MULTI_FOLDER Number of samples successfully generated
Number of samples that failed to generate
Total cost of the run in dollars
When the run was created
Email of the user who created the run
When the run completed (null if not finished)