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
}
'import requests
url = "https://api.example.com/api/playground/sessions/{session_id}/publish"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.example.com/api/playground/sessions/{session_id}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/playground/sessions/{session_id}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/playground/sessions/{session_id}/publish"
payload := strings.NewReader("{\n \"dataset_name\": \"<string>\",\n \"target_column\": \"<string>\",\n \"target_label_column\": \"<string>\",\n \"split_column\": \"split\",\n \"generate_splits\": false,\n \"include_train\": true,\n \"include_val\": true,\n \"include_test\": true,\n \"train_ratio\": 0.7,\n \"val_ratio\": 0.15,\n \"test_ratio\": 0.15,\n \"random_state\": 42,\n \"path_column\": \"<string>\",\n \"materialize_mode\": \"symlink\",\n \"run_scan\": false,\n \"scan_type\": \"<string>\",\n \"scan_params\": {},\n \"carry_hypotheses\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/playground/sessions/{session_id}/publish")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dataset_name\": \"<string>\",\n \"target_column\": \"<string>\",\n \"target_label_column\": \"<string>\",\n \"split_column\": \"split\",\n \"generate_splits\": false,\n \"include_train\": true,\n \"include_val\": true,\n \"include_test\": true,\n \"train_ratio\": 0.7,\n \"val_ratio\": 0.15,\n \"test_ratio\": 0.15,\n \"random_state\": 42,\n \"path_column\": \"<string>\",\n \"materialize_mode\": \"symlink\",\n \"run_scan\": false,\n \"scan_type\": \"<string>\",\n \"scan_params\": {},\n \"carry_hypotheses\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/playground/sessions/{session_id}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset_name\": \"<string>\",\n \"target_column\": \"<string>\",\n \"target_label_column\": \"<string>\",\n \"split_column\": \"split\",\n \"generate_splits\": false,\n \"include_train\": true,\n \"include_val\": true,\n \"include_test\": true,\n \"train_ratio\": 0.7,\n \"val_ratio\": 0.15,\n \"test_ratio\": 0.15,\n \"random_state\": 42,\n \"path_column\": \"<string>\",\n \"materialize_mode\": \"symlink\",\n \"run_scan\": false,\n \"scan_type\": \"<string>\",\n \"scan_params\": {},\n \"carry_hypotheses\": false\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}playground
Publish Session As Dataset
Materialize a playground session into a persisted Blindsight dataset, optionally enqueueing a scan.
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
}
'import requests
url = "https://api.example.com/api/playground/sessions/{session_id}/publish"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.example.com/api/playground/sessions/{session_id}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/playground/sessions/{session_id}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/playground/sessions/{session_id}/publish"
payload := strings.NewReader("{\n \"dataset_name\": \"<string>\",\n \"target_column\": \"<string>\",\n \"target_label_column\": \"<string>\",\n \"split_column\": \"split\",\n \"generate_splits\": false,\n \"include_train\": true,\n \"include_val\": true,\n \"include_test\": true,\n \"train_ratio\": 0.7,\n \"val_ratio\": 0.15,\n \"test_ratio\": 0.15,\n \"random_state\": 42,\n \"path_column\": \"<string>\",\n \"materialize_mode\": \"symlink\",\n \"run_scan\": false,\n \"scan_type\": \"<string>\",\n \"scan_params\": {},\n \"carry_hypotheses\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/playground/sessions/{session_id}/publish")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dataset_name\": \"<string>\",\n \"target_column\": \"<string>\",\n \"target_label_column\": \"<string>\",\n \"split_column\": \"split\",\n \"generate_splits\": false,\n \"include_train\": true,\n \"include_val\": true,\n \"include_test\": true,\n \"train_ratio\": 0.7,\n \"val_ratio\": 0.15,\n \"test_ratio\": 0.15,\n \"random_state\": 42,\n \"path_column\": \"<string>\",\n \"materialize_mode\": \"symlink\",\n \"run_scan\": false,\n \"scan_type\": \"<string>\",\n \"scan_params\": {},\n \"carry_hypotheses\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/playground/sessions/{session_id}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset_name\": \"<string>\",\n \"target_column\": \"<string>\",\n \"target_label_column\": \"<string>\",\n \"split_column\": \"split\",\n \"generate_splits\": false,\n \"include_train\": true,\n \"include_val\": true,\n \"include_test\": true,\n \"train_ratio\": 0.7,\n \"val_ratio\": 0.15,\n \"test_ratio\": 0.15,\n \"random_state\": 42,\n \"path_column\": \"<string>\",\n \"materialize_mode\": \"symlink\",\n \"run_scan\": false,\n \"scan_type\": \"<string>\",\n \"scan_params\": {},\n \"carry_hypotheses\": false\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Cookies
Body
application/json
Available options:
symlink, copy Response
Successful Response
⌘I

