Skip to main content

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.

Download Microsoft Edge More info about Internet Explorer and Microsoft Edge
microsoft-foundry.rest.security.o-auth2-auth

DataGenerationJobs

Create a data generation job

POST /data_generation_jobs

Submits a new data generation job for asynchronous execution.

Header parameters

Foundry-Features enum

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

DataGenerationJobs=V1Preview
Operation-Id string

Client-generated unique ID for idempotent retries. When absent, the server creates the job unconditionally.

Query parameters

api-version string required

The API version to use for this operation.

Request Body

The data generation job inputs to create.

Content-Type: application/json
One of the following:
evaluation EvaluationDataGenerationJobInputs

Caller-supplied inputs for an evaluation data generation job.

scenario enum required

The scenario of the data generation job, which is Evaluation for this model.

evaluation
output_configuration EvaluationDataGenerationJobOutputConfiguration

Dataset output configuration for an evaluation data generation job.

name string

Dataset name to assign to the output.

description string

Description to assign to the output dataset.

tags object

Tags to assign to the output dataset.

[key: string] string
write_mode string | enum

The supported write modes for data generation job outputs.

Any of the following:
string
enum
overwritemerge
supervised_finetuning_preview SupervisedFineTuningDataGenerationJobInputs

Caller-supplied inputs for a supervised fine-tuning data generation job. This is a preview feature.

scenario enum required

The scenario of the data generation job, which is Supervised Fine-tuning preview for this model.

supervised_finetuning_preview
output_configuration SupervisedFineTuningDataGenerationJobOutputConfiguration

File output configuration for a supervised fine-tuning data generation job. This is a preview feature.

name string required

Filename to assign to the generated fine-tuning file.

write_mode string | enum

The supported write modes for data generation job outputs.

Any of the following:
string
enum
overwritemerge
merge_file_id string

File ID to merge into when write_mode is merge.

reinforcement_finetuning_preview ReinforcementFineTuningDataGenerationJobInputs

Caller-supplied inputs for a reinforcement fine-tuning data generation job. This is a preview feature.

scenario enum required

The scenario of the data generation job, which is Reinforcement Fine-tuning preview for this model.

reinforcement_finetuning_preview
output_configuration ReinforcementFineTuningDataGenerationJobOutputConfiguration

File output configuration for a reinforcement fine-tuning data generation job. This is a preview feature.

name string required

Filename to assign to the generated fine-tuning file.

write_mode string | enum

The supported write modes for data generation job outputs.

Any of the following:
string
enum
overwritemerge
merge_file_id string

File ID to merge into when write_mode is merge.

Responses

The request has succeeded and a new resource has been created as a result.

Headers

Operation-Location string required

URL to poll for the job status.

Location string required

URL of the created job resource.

Body

Content-Type: application/json
One of the following:
evaluation EvaluationDataGenerationJob

Evaluation data generation job resource.

scenario enum required

The scenario of the data generation job, which is Evaluation for this model.

evaluation
output_configuration EvaluationDataGenerationJobOutputConfiguration

Dataset output configuration for an evaluation data generation job.

name string

Dataset name to assign to the output.

description string

Description to assign to the output dataset.

tags object

Tags to assign to the output dataset.

[key: string] string
write_mode string | enum

The supported write modes for data generation job outputs.

Any of the following:
string
enum
overwritemerge
supervised_finetuning_preview SupervisedFineTuningDataGenerationJob

Supervised fine-tuning data generation job resource. This is a preview feature.

scenario enum required

The scenario of the data generation job, which is Supervised Fine-tuning preview for this model.

supervised_finetuning_preview
output_configuration SupervisedFineTuningDataGenerationJobOutputConfiguration

File output configuration for a supervised fine-tuning data generation job. This is a preview feature.

name string required

Filename to assign to the generated fine-tuning file.

write_mode string | enum

The supported write modes for data generation job outputs.

Any of the following:
string
enum
overwritemerge
merge_file_id string

File ID to merge into when write_mode is merge.

reinforcement_finetuning_preview ReinforcementFineTuningDataGenerationJob

Reinforcement fine-tuning data generation job resource. This is a preview feature.

scenario enum required

The scenario of the data generation job, which is Reinforcement Fine-tuning preview for this model.

reinforcement_finetuning_preview
output_configuration ReinforcementFineTuningDataGenerationJobOutputConfiguration

File output configuration for a reinforcement fine-tuning data generation job. This is a preview feature.

name string required

Filename to assign to the generated fine-tuning file.

write_mode string | enum

The supported write modes for data generation job outputs.

Any of the following:
string
enum
overwritemerge
merge_file_id string

File ID to merge into when write_mode is merge.

Client error

Body

Content-Type: application/json
error OpenAI.Error required
code string | null required
message string required
param string | null
type string
misalignment OpenAI.MisalignmentErrorDetailsResource
review_target string | null
error_type string | enum
Any of the following:
string
enum
potentially_unintended_data_transferpotentially_unintended_data_accesspotentially_unintended_destructive_activityother
detailed_explanation string

The public explanation for this block.

steer OpenAI._MisalignmentSteer
message string required

The public continuation instruction.

details OpenAI.Error[]
additionalInfo object
debugInfo object

Server error

Body

Content-Type: application/json
error OpenAI.Error required
code string | null required
message string required
param string | null
type string
misalignment OpenAI.MisalignmentErrorDetailsResource
review_target string | null
error_type string | enum
Any of the following:
string
enum
potentially_unintended_data_transferpotentially_unintended_data_accesspotentially_unintended_destructive_activityother
detailed_explanation string

The public explanation for this block.

steer OpenAI._MisalignmentSteer
message string required

The public continuation instruction.

details OpenAI.Error[]
additionalInfo object
debugInfo object

Request

POST /data_generation_jobs HTTP/1.1

Response

Status: 201
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
en-us
Your Privacy Choices
  • AI Disclaimer
  • Previous Versions
  • Blog
  • Contribute
  • Privacy
  • Consumer Health Privacy
  • Terms of Use
  • Trademarks
  • © Microsoft 2026