Hire WorkforceRequest Demo
Documentation

Download

You can download your project in two ways: from the Downloads tab in FineTune, or by clicking Download on the floating bar in Explore.

Only Team Admins, Team Owners, and Project Admins (with the necessary permissions) may download project data.

🚧

About CSV exports

The SuperAnnotate CSV format export is only supported for components whose values are a string or number, as CSV files don’t support complex data types.

📘

About File Upload components

  • If the items you’re downloading contain a File Upload component and have files attached to them, then the exported files will include signed URLs of each file. The URL is structured as follows:
    https://assets-api.superannotate.com/api/v1/storages/download/{token} - where {token} is a signed and time-limited token used to securely authorize file downloads.
  • These links will be valid for 7 days only, and they’ll remain available even if any corresponding items are deleted.
  • If an item includes multiple attached files, the URLs will be shown as such follows, depending on the download type:
    • JSON - A list of objects under the “attributes” key. Each object contains the ”name” key, whose value is the signed URL.
    • JSONL - An array of strings under the ”value” key.
    • CSV - A single field containing an array of strings.

Download from FineTune

To download your project:

  1. Go to the Downloads tab.
  2. Click Prepare Download.
  3. Select a format: SuperAnnotate JSON, SuperAnnotate JSONL, or SuperAnnotate CSV.
  4. In the pop-up, type in a name.
  5. Select the folders you want to include in your download.
  6. Select one or multiple statuses to filter which items to include in your download.
  7. If you’ve selected the SuperAnnotate CSV format, and you’d like to include the update and creation timestamps for instances in your exported CSV file, check the corresponding box.
  8. Once you’re done, click Prepare.
  9. After the download is prepared, click Download. You can cancel the preparation stage by clicking Cancel instead.

Download projects with an external annotation storage

If you want to download a project whose annotation data is being stored in an external storage, then you’ll also need to specify the annotation location path.

To download a project this way:

  1. In Downloads, click Prepare Download.
  2. Select the folders you want to include in your download.
  3. Select one or multiple statuses to filter which items to include in your download.
  4. Select an annotation location path available to your team from the dropdown.
  5. Check Pinned items to include pinned items in your download (Optional, for local projects only).
  6. Click Prepare.
  7. When the download is complete, select one of two download options:
    • Get dataset link - you’ll receive a download link that will expire after 1 hour. Anyone with access to the link will be able to download the project data.
    • Download dataset - a zip file containing your project dataset will be downloaded without storing any data on SuperAnnotate’s servers.
📘
  • When you prepare your project’s dataset for download, the exportable data will be stored in the location you specify.
  • If there isn’t a folder corresponding to the path name you’ve provided, one will be created during preparation.
  • The folder will be created with the following path: export / TEAM ID / PROJECT ID / DATASET_NAME.zip
  • If the annotations have been deleted, then a folder will be created at the provided path with an empty zip file.

Download from Explore

  1. When in your project, go to Explore.
  2. Select the items whose annotation data you want to download.
  3. Click Download on the floating bar.
  4. Select a format: JSON, JSONL or CSV.
  5. Find the download being prepared in the Downloads tab in FineTune.
  6. When the annotation files are ready, click Download.

Download annotation CSV

You can download your project’s annotations in CSV format from the project’s Downloads tab. You can choose to download the whole project or specify parts of it. The exported CSV file will follow the exact same format, and it will only include components of the Input, Select, and Media types that haven’t been excluded from export.

📘

Projects Admins (with download permission) and users with higher roles will be able to download the _item_category and _folder in the SuperAnnotate CSV format.

Prepare and download export with SDK

You can also prepare your download with the following SDK functions: prepare_export() and download_export().

Here are some examples on how you can set up your functions.

Rename download file

To rename a downloaded file:

  1. In the Downloads tab, find the downloaded file that you want to rename.
  2. Click the ellipsis button.
  3. Select Rename.
  4. Type a new name. The name can’t contain any of the following characters: / \ : * ? " < > |

Cancel download preparation

To cancel a download preparation:

  1. In the Downloads tab, find the download preparation that you want to cancel.
  2. Click Cancel.
  3. In the popup, click Cancel.

Delete download file

To delete a download file:

  1. Go to the Downloads tab.
  2. Click the delete button that corresponds to the file you want to delete.
  3. In the popup, click Delete.
❗️

If the deleted file has a download link, the link will be expired.

🚧

If a download you want to delete has been stored on an external cloud storage, it will only be deleted from the download list. To delete the stored file as well, you will have to do so manually from the external container.

Delete with SDK

You can use the following Python SDK function to delete a download file: delete_exports()