exports
/api/v1/exports/
Export all dataset or project results (async)
POST
/
exports
/
/api/v1/exports/
curl --request POST \
--url https://api.avala.ai/api/v1/exports/ \
--header 'Content-Type: application/json' \
--header 'X-Avala-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"datasets": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"slices": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"projects": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filter_query_string": "<string>",
"total_task_count": 1073741823,
"exported_task_count": 1073741823,
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
}
}
'import requests
url = "https://api.avala.ai/api/v1/exports/"
payload = {
"name": "<string>",
"datasets": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"slices": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"projects": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"filter_query_string": "<string>",
"total_task_count": 1073741823,
"exported_task_count": 1073741823,
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
}
}
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>',
datasets: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
slices: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
projects: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
filter_query_string: '<string>',
total_task_count: 1073741823,
exported_task_count: 1073741823,
organization: {name: '<string>', description: '<string>', website: '<string>'}
})
};
fetch('https://api.avala.ai/api/v1/exports/', 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/exports/",
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>',
'datasets' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'slices' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'projects' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'filter_query_string' => '<string>',
'total_task_count' => 1073741823,
'exported_task_count' => 1073741823,
'organization' => [
'name' => '<string>',
'description' => '<string>',
'website' => '<string>'
]
]),
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/exports/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasets\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"slices\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"projects\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filter_query_string\": \"<string>\",\n \"total_task_count\": 1073741823,\n \"exported_task_count\": 1073741823,\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n }\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/exports/")
.header("X-Avala-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasets\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"slices\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"projects\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filter_query_string\": \"<string>\",\n \"total_task_count\": 1073741823,\n \"exported_task_count\": 1073741823,\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avala.ai/api/v1/exports/")
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 \"datasets\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"slices\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"projects\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filter_query_string\": \"<string>\",\n \"total_task_count\": 1073741823,\n \"exported_task_count\": 1073741823,\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"datasets": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"slices": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"projects": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter_query_string": "<string>",
"total_task_count": 1073741823,
"exported_task_count": 1073741823,
"download_url": "<string>",
"organization": {
"name": "<string>",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"description": "<string>",
"logo": "<string>",
"website": "<string>",
"public_slug": "<string>"
},
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
API_KeyJWT
API key for authentication. Generate one in Mission Control Settings > Security & Identity.
Body
application/json
Required string length:
1 - 255Available options:
avala-json-external, YOLO Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Available options:
requested, aborted, exporting, exported, failed Show child attributes
Show child attributes
Response
201 - application/json
Required string length:
1 - 255Available options:
avala-json-external, YOLO Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Available options:
requested, aborted, exporting, exported, failed Show child attributes
Show child attributes
Was this page helpful?
⌘I
/api/v1/exports/
curl --request POST \
--url https://api.avala.ai/api/v1/exports/ \
--header 'Content-Type: application/json' \
--header 'X-Avala-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"datasets": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"slices": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"projects": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filter_query_string": "<string>",
"total_task_count": 1073741823,
"exported_task_count": 1073741823,
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
}
}
'import requests
url = "https://api.avala.ai/api/v1/exports/"
payload = {
"name": "<string>",
"datasets": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"slices": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"projects": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"filter_query_string": "<string>",
"total_task_count": 1073741823,
"exported_task_count": 1073741823,
"organization": {
"name": "<string>",
"description": "<string>",
"website": "<string>"
}
}
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>',
datasets: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
slices: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
projects: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
filter_query_string: '<string>',
total_task_count: 1073741823,
exported_task_count: 1073741823,
organization: {name: '<string>', description: '<string>', website: '<string>'}
})
};
fetch('https://api.avala.ai/api/v1/exports/', 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/exports/",
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>',
'datasets' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'slices' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'projects' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'filter_query_string' => '<string>',
'total_task_count' => 1073741823,
'exported_task_count' => 1073741823,
'organization' => [
'name' => '<string>',
'description' => '<string>',
'website' => '<string>'
]
]),
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/exports/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasets\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"slices\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"projects\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filter_query_string\": \"<string>\",\n \"total_task_count\": 1073741823,\n \"exported_task_count\": 1073741823,\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n }\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/exports/")
.header("X-Avala-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasets\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"slices\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"projects\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filter_query_string\": \"<string>\",\n \"total_task_count\": 1073741823,\n \"exported_task_count\": 1073741823,\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avala.ai/api/v1/exports/")
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 \"datasets\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"slices\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"projects\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"filter_query_string\": \"<string>\",\n \"total_task_count\": 1073741823,\n \"exported_task_count\": 1073741823,\n \"organization\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"website\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"datasets": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"slices": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"projects": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter_query_string": "<string>",
"total_task_count": 1073741823,
"exported_task_count": 1073741823,
"download_url": "<string>",
"organization": {
"name": "<string>",
"uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"description": "<string>",
"logo": "<string>",
"website": "<string>",
"public_slug": "<string>"
},
"created_at": "2023-11-07T05:31:56Z"
}