slices
Post slices
POST
/
slices
/
cURL
curl --request POST \
--url https://api.avala.ai/api/v1/slices/ \
--header 'Content-Type: application/json' \
--header 'X-Avala-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"sub_slices": [
{
"dataset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_item_uids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filters": {}
}
],
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
},
"random_selection_count": 123
}
'import requests
url = "https://api.avala.ai/api/v1/slices/"
payload = {
"name": "<string>",
"sub_slices": [
{
"dataset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_item_uids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"filters": {}
}
],
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
},
"random_selection_count": 123
}
headers = {
"X-Avala-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Avala-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
sub_slices: [
{
dataset_uid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dataset_item_uids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
filters: {}
}
],
organization: {name: '<string>', description: '<string>', website: '<string>'},
random_selection_count: 123
})
};
fetch('https://api.avala.ai/api/v1/slices/', 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.avala.ai/api/v1/slices/",
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([
'name' => '<string>',
'sub_slices' => [
[
'dataset_uid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dataset_item_uids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'filters' => [
]
]
],
'organization' => [
'name' => '<string>',
'description' => '<string>',
'website' => '<string>'
],
'random_selection_count' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Avala-Api-Key: <api-key>"
],
]);
$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.avala.ai/api/v1/slices/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"sub_slices\": [\n {\n \"dataset_uid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_item_uids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filters\": {}\n }\n ],\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n },\n \"random_selection_count\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Avala-Api-Key", "<api-key>")
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.avala.ai/api/v1/slices/")
.header("X-Avala-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"sub_slices\": [\n {\n \"dataset_uid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_item_uids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filters\": {}\n }\n ],\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n },\n \"random_selection_count\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avala.ai/api/v1/slices/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Avala-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"sub_slices\": [\n {\n \"dataset_uid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_item_uids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filters\": {}\n }\n ],\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n },\n \"random_selection_count\": 123\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"slug": "<string>",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_name": "<string>",
"organization": {
"name": "<string>",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"description": "<string>",
"logo": "<string>",
"website": "<string>",
"public_slug": "<string>"
},
"sub_slices": [
{
"dataset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_item_uids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filters": {}
}
],
"source_data": {},
"featured_slice_item_urls": [
"<string>"
],
"item_count": 123
}Authorizations
API_KeyJWT
API key for authentication. Generate one in Mission Control Settings > Security & Identity.
Body
application/json
Required string length:
1 - 100Visibility setting for the slice.
Available options:
public, private An Array of sub slice objects. The available sub_slice types are:
dataset_items: a preselected list of dataset items in a dataset
{
"type": "dataset_items",
"dataset_uid": <dataset_uid>
"dataset_item_uids": [
<dataset_item_uid>,
<dataset_item_uid>
...
]
}
dataset: all dataset items in selected dataset
{
"type": "dataset",
"dataset_uid": <dataset_uid>
}
filters: selects dataset items from dataset by applying filter expressions
{
"type": "filters",
"dataset_uid": <dataset_uid>,
"filters":
<filter_expression>,
}
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
201 - application/json
Required string length:
1 - 100Required string length:
1 - 100The name of the slice owner
Minimum string length:
1Show child attributes
Show child attributes
Available options:
public, private Show child attributes
Show child attributes
Available options:
pending, created, failed List of the first 4 found slice items' URL
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://api.avala.ai/api/v1/slices/ \
--header 'Content-Type: application/json' \
--header 'X-Avala-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"sub_slices": [
{
"dataset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_item_uids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filters": {}
}
],
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
},
"random_selection_count": 123
}
'import requests
url = "https://api.avala.ai/api/v1/slices/"
payload = {
"name": "<string>",
"sub_slices": [
{
"dataset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_item_uids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"filters": {}
}
],
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
},
"random_selection_count": 123
}
headers = {
"X-Avala-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Avala-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
sub_slices: [
{
dataset_uid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dataset_item_uids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
filters: {}
}
],
organization: {name: '<string>', description: '<string>', website: '<string>'},
random_selection_count: 123
})
};
fetch('https://api.avala.ai/api/v1/slices/', 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.avala.ai/api/v1/slices/",
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([
'name' => '<string>',
'sub_slices' => [
[
'dataset_uid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dataset_item_uids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'filters' => [
]
]
],
'organization' => [
'name' => '<string>',
'description' => '<string>',
'website' => '<string>'
],
'random_selection_count' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Avala-Api-Key: <api-key>"
],
]);
$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.avala.ai/api/v1/slices/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"sub_slices\": [\n {\n \"dataset_uid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_item_uids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filters\": {}\n }\n ],\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n },\n \"random_selection_count\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Avala-Api-Key", "<api-key>")
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.avala.ai/api/v1/slices/")
.header("X-Avala-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"sub_slices\": [\n {\n \"dataset_uid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_item_uids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filters\": {}\n }\n ],\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n },\n \"random_selection_count\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avala.ai/api/v1/slices/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Avala-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"sub_slices\": [\n {\n \"dataset_uid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_item_uids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filters\": {}\n }\n ],\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n },\n \"random_selection_count\": 123\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"slug": "<string>",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_name": "<string>",
"organization": {
"name": "<string>",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"description": "<string>",
"logo": "<string>",
"website": "<string>",
"public_slug": "<string>"
},
"sub_slices": [
{
"dataset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_item_uids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filters": {}
}
],
"source_data": {},
"featured_slice_item_urls": [
"<string>"
],
"item_count": 123
}