Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Exports

Create an export

Requests a new export which is processed asynchronously.

post/api/v2/teams/{team_slug}/datasets/{dataset_slug}/exports

Path parameters

team_slugstring required

Team's sluggified name

dataset_slugstring required

Dataset's slugified name

Example:my-dataset

Dataset's slugified name

Request body

format'darwin_json_2' | 'xml' | 'coco' | 'cvat' | 'pascalvoc' | 'semantic_mask' | 'instance_mask' | 'nifti' | 'yolo' | 'yolo_segmented'

Export format

include_authorshipboolean
include_export_tokenboolean
namestring required

Export name. Has to be unique within dataset.

Example request

{
  "annotation_filters": {
    "annotation_class_ids": [
      123
    ]
  },
  "filters": {
    "annotation_class_ids": [
      123
    ],
    "assignees": [
      123
    ],
    "current_assignees": [
      123
    ],
    "item_ids": [
      "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    ],
    "item_name_contains": "item",
    "item_name_prefix": "prefix_",
    "item_names": [
      "my item"
    ],
    "item_path_prefix": "/some/prefix",
    "item_paths": [
      "/some/path"
    ],
    "not_annotation_class_ids": [
      123
    ],
    "not_assignees": [
      123
    ],
    "not_current_assignees": [
      123
    ],
    "not_item_ids": [
      "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    ],
    "not_item_name_contains": "item",
    "not_item_name_prefix": "prefix_",
    "not_item_names": [
      "my item"
    ],
    "not_item_path_prefix": "/some/prefix",
    "not_item_paths": [
      "/some/path"
    ],
    "not_statuses": ",",
    "not_types": [
      "image"
    ],
    "not_workflow_stage_ids": [
      "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    ],
    "select_all": true,
    "statuses": ",",
    "types": [
      "image"
    ],
    "workflow_stage_ids": [
      "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    ]
  }
}

Response

DatasetsV2.Export.Export

download_urlstring nullable required
format'json' | 'darwin_json_2' | 'xml' | 'coco' | 'cvat' | 'pascalvoc' | 'semantic_mask' | 'instance_mask' | 'nifti' | 'yolo' | 'yolo_segmented' required

Export format

inserted_atstring date-time required

Date and time when the export was created.

latestboolean required
metadataDatasetsV2ExportMetadata required
namestring required

Export name. Has to be unique within dataset.

status'pending' | 'complete' | 'failed' nullable required
versioninteger required