Skip to main content
POST
Run operation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
params
YQLParams · object
required

YQL query parameters.

Example:
src
OperationSrcDataset · object[]
required

List of source datasets for the operation.

Example:
type
string
default:yql
Allowed value: "yql"
dst
OperationDstDataset · object[]

Optional destination datasets. If not provided, a temporary dataset will be created.

Example:
ai_project_id
string | null

AI Studio project ID to associate with the dataset.

Example:

"example_project"

Response

Successful Response

id
string
required

Operation id

Example:

"3a3fd2317bbe4b3bb9842bc1b5275eb9"

type
enum<string>
required

Type of the operation.

Available options:
yql,
materialize_history,
batch_inference,
finetuning,
file_to_dataset,
dataset_to_file,
merge
Examples:

"yql"

"materialize_history"

"batch_inference"

"finetuning"

"file_to_dataset"

"dataset_to_file"

"merge"

params
YQLParams · object
required

Parameters specific to the operation type.

Example:
src
(OperationSrcDataset · object | OperationSrcTrainDataset · object | OperationSrcValidationDataset · object | OperationSrcDatasetToFile · object)[]
required

List of source datasets for the operation.

Example:
dst
OperationDstDataset · object[]
required

List of destination datasets for the operation.

Example:
status
enum<string>
required

Current status of the operation.

Available options:
queued,
running,
succeeded,
failed,
cancelled,
unknown
Examples:

"queued"

"running"

"succeeded"

"failed"

"cancelled"

"unknown"

created_at
integer
required

The Unix timestamp (in seconds) for when the operation was created.

Example:

1614807352

in_progress_at
integer | null

The Unix timestamp (in seconds) for when the operation started processing.

Example:

1614807352

finished_at
integer | null

The Unix timestamp (in seconds) for when the operation was completed.

Example:

1614807352

ai_project_id
string | null

AI Studio project ID to associate with the dataset.

Example:

"example_project"