Skip to main content
GET
/
api
/
dataframer
/
specs
/
{spec_id}
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
)
spec = client.dataframer.specs.retrieve(
    spec_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(spec.id)
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Customer Support Conversations Spec",
  "description": "Spec for generating synthetic customer support conversations",
  "status": "PROCESSING",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z",
  "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "dataset_name": "Customer Support Dataset",
  "created_by_email": "[email protected]",
  "content_yaml": null,
  "versions": []
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

​
spec_id
string<uuid>
required

UUID of the spec

Query Parameters

​
include_versions
boolean
default:false

Include all previous spec versions in the response

Response

Spec details

​
id
string<uuid>

Unique identifier for the spec

​
name
string

Spec name

​
description
string

Description of the spec's purpose (optional, for data organization purposes only)

​
status
enum<string>

Current status of the spec

Available options:
PROCESSING,
SUCCEEDED,
FAILED
​
created_at
string<date-time>

Timestamp when the spec was created

​
updated_at
string<date-time>

Timestamp when the spec was last modified

​
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.

​
created_by_email
string

Email of the user who created this spec

​
runtime_params
object

Parameters used during spec generation (model name, distribution settings, etc.)

​
versions
object[]

All versions of this spec. Only included when include_versions=true. Empty when status is PROCESSING or FAILED.

​
content_yaml
string | null

The YAML content from the latest version of this spec. Null when status is PROCESSING or FAILED.

​
error
string | null

Error message when status is FAILED. Null otherwise.