Skip to main content
POST
/
api
/
playground
/
sessions
/
{session_id}
/
publish
Publish Session As Dataset
curl --request POST \
  --url https://api.example.com/api/playground/sessions/{session_id}/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset_name": "<string>",
  "target_column": "<string>",
  "target_label_column": "<string>",
  "split_column": "split",
  "generate_splits": false,
  "include_train": true,
  "include_val": true,
  "include_test": true,
  "train_ratio": 0.7,
  "val_ratio": 0.15,
  "test_ratio": 0.15,
  "random_state": 42,
  "path_column": "<string>",
  "materialize_mode": "symlink",
  "run_scan": false,
  "scan_type": "<string>",
  "scan_params": {},
  "carry_hypotheses": false
}
'
{
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "dataset_dir": "<string>",
  "dataset_type": "<string>",
  "split_column": "<string>",
  "target_column": "<string>",
  "target_label_column": "<string>",
  "metadata_csv": "<string>",
  "generated_files": [],
  "linked_paths": 0,
  "skipped_paths": 0,
  "scan_id": "<string>",
  "warning": "<string>"
}

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

session_id
string
required

Cookies

antidote_session
string | null

Body

application/json
dataset_name
string | null
target_column
string | null
target_label_column
string | null
split_column
string | null
default:split
generate_splits
boolean
default:false
include_train
boolean
default:true
include_val
boolean
default:true
include_test
boolean
default:true
train_ratio
number
default:0.7
val_ratio
number
default:0.15
test_ratio
number
default:0.15
random_state
integer
default:42
path_column
string | null
materialize_mode
enum<string>
default:symlink
Available options:
symlink,
copy
run_scan
boolean
default:false
scan_type
string | null
scan_params
Scan Params · object
carry_hypotheses
boolean
default:false

Response

Successful Response

dataset_id
string
required
dataset_name
string
required
dataset_dir
string
required
dataset_type
string
required
split_column
string | null
target_column
string | null
target_label_column
string | null
metadata_csv
string | null
generated_files
string[]
linked_paths
integer
default:0
skipped_paths
integer
default:0
scan_id
string | null
warning
string | null