Skip to main content
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>",
  "visibility": "public",
  "sub_slices": [
    {
      "type": "dataset_items",
      "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
}
'
{
  "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>"
  },
  "visibility": "public",
  "sub_slices": [
    {
      "type": "dataset_items",
      "dataset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset_item_uids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "filters": {}
    }
  ],
  "source_data": {},
  "status": "pending",
  "featured_slice_item_urls": [
    "<string>"
  ],
  "item_count": 123
}

Authorizations

​
X-Avala-Api-Key
string
header
required

API key for authentication. Generate one in Mission Control Settings > Security & Identity.

Body

application/json
​
name
string
required
Required string length: 1 - 100
​
visibility
enum<string>
required

Visibility setting for the slice.

Available options:
public,
private
​
sub_slices
object[]
required

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>,
}
​
organization
object
​
random_selection_count
integer | null

Response

201 - application/json
​
name
string
required
Required string length: 1 - 100
​
slug
string
required
Required string length: 1 - 100
​
uid
string<uuid>
​
owner_name
string

The name of the slice owner

Minimum string length: 1
​
organization
object
​
visibility
enum<string>
Available options:
public,
private
​
sub_slices
object[]
​
source_data
Source data · object
​
status
enum<string>
Available options:
pending,
created,
failed
​
featured_slice_item_urls
(string | null)[]

List of the first 4 found slice items' URL

​
item_count
integer