Skip to main content
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>",
  "format": "avala-json-external",
  "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,
  "download_url": "<string>",
  "status": "requested",
  "organization": {
    "name": "<string>",
    "description": "<string>",
    "website": "<string>"
  }
}
'
{
  "name": "<string>",
  "format": "avala-json-external",
  "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>",
  "status": "requested",
  "organization": {
    "name": "<string>",
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "description": "<string>",
    "logo": "<string>",
    "website": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z"
}

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 - 255
​
format
enum<string>
required
Available options:
avala-json-external,
YOLO
​
datasets
string<uuid>[]
required
​
slices
string<uuid>[]
required
​
projects
string<uuid>[]
required
​
filter_query_string
string | null
​
total_task_count
integer | null
Required range: 0 <= x <= 2147483647
​
exported_task_count
integer | null
Required range: 0 <= x <= 2147483647
​
download_url
string | null
Required string length: 1 - 1000
​
status
enum<string>
Available options:
requested,
aborted,
exporting,
exported,
failed
​
organization
object

Response

201 - application/json
​
name
string
required
Required string length: 1 - 255
​
format
enum<string>
required
Available options:
avala-json-external,
YOLO
​
datasets
string<uuid>[]
required
​
slices
string<uuid>[]
required
​
projects
string<uuid>[]
required
​
uid
string<uuid>
​
filter_query_string
string | null
​
total_task_count
integer | null
Required range: 0 <= x <= 2147483647
​
exported_task_count
integer | null
Required range: 0 <= x <= 2147483647
​
download_url
string | null
Required string length: 1 - 1000
​
status
enum<string>
Available options:
requested,
aborted,
exporting,
exported,
failed
​
organization
object
​
created_at
string<date-time>