Skip to main content
POST
Create a fine-tuning dataset proposal

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Start a dataset-generation run for a DataHub domain.

domain
string
required

DataHub domain name or URN whose knowledge seeds the dataset.

Maximum string length: 512
base_model
string
required

Base model this dataset will fine-tune. Must be present in FINETUNE_BASE_MODEL_ALLOWLIST; validated server-side.

Maximum string length: 256
name
string | null

Human-friendly dataset name. Defaults to '-finetune'.

Maximum string length: 256
extra_instructions
string | null

Free-form guidance and facts the user wants baked in — extra context the crew should weave into the training examples.

Maximum string length: 20000
target_examples
integer | null

Soft target for how many Q/A examples to generate. Clamped by FINETUNE_DATASET_CREW_MAX_EXAMPLES.

Required range: 1 <= x <= 500
include_glossary
boolean
default:true
include_documents
boolean
default:true
include_lineage
boolean
default:true
include_tags
boolean
default:true
include_data_products
boolean
default:true
owner
string | null

Owner username. Ignored for non-admin callers (the authenticated user is always the owner); admins may set it to create on behalf of another user.

Maximum string length: 256

Response

Crew run started. Poll the job for the proposal.

The crew's proposed dataset, returned for review.

The full example set lives in S3 (proposed_dataset_s3 / after approval, approved_dataset_s3). sample_examples is a bounded preview.

job_id
string<uuid>
required
status
enum<string>
required

Lifecycle of a fine-tuning dataset job.

Available options:
running,
pending_approval,
failed,
approved,
materializing,
complete
name
string
required
domain
string
required
base_model
string
required
owner
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
example_count
integer
default:0
coverage
CoverageStats · object | null

How much of the domain the crew drew on.

sample_examples
QAExample · object[]
notes
string | null
proposed_dataset_s3
string | null
approved_dataset_s3
string | null
mlflow_dataset_uri
string | null
error
string | null