Direct Upload

The quickest way to upload your items into your project is by Direct Upload. You can upload your data into the root of the project, or a specified folder.

🚧

Item naming restrictions

When naming your items, please avoid using the following special characters as they may lead to unexpected behavior or compatibility issues:
< > : ” ' / \ | ? * & \0 $ ! +

Supported project types

You can make use of this import method for the following project types:

  • Image
  • Image (Legacy)

Upload methods

There are three ways you can upload your items directly into a project:

  • From your computer
  • From an S3 bucket
  • By using SDK or CLI.

Upload from computer

To upload your files from your computer:

  1. When in the Data tab of your project, click Add.
  2. Select an option based on the file type: Upload Images, Upload Video (with frames), Upload PDF (with frames), or Upload DICOM (with frames).
  3. Drag and drop your files, or upload them from your computer.
  4. Click Upload.

Import from S3 bucket

You can only use this import method with image files.

To import images from your S3 bucket:

  1. When in the Data tab of your project, click Add.
  2. Select Upload Images.
  3. Go to the Import from S3 Bucket tab.
  4. Fill in the following fields: Access Key ID, Secret Access key, Bucket name, and Folder name (optional).
  5. Click Test to see whether you have access to the S3 bucket or not.
  6. If you have access to the S3 bucket, click Start.

📘

How to get the access key ID and the secret access key?

  1. Go to your AWS console.
  2. Click on the name of your account in the top right corner.
  3. Select Security credentials.
  4. Expand Access keys (access key ID and secret access key). You'll see a list of your active and inactive keys.
  5. To create a new key, click Create Access Key.
  6. Click Show to see your Secret Access Key, as your Access Key ID is already visible.
  7. Click Download .csv file, which contains both your Access Key ID and your Secret Access Key, to save it for later. Please note that if you close the window, you won't be able to see your Secret Access Key again.

🚧

About folders

  • Note that when you type in a folder path, all items within that folder will be uploaded. You won't be able to select and choose specific files from the folder.

Python SDK and CLI

Here's an example for Python SDK to upload images from your computer, directly into your project: upload_images_from_folder_to_project()

sa.upload_images_from_folder_to_project(
    project = "Project Name",
    folder_path = "./data/images")
superannotatecli upload-images --project “Project Name” --folder “./data/images”

Here's an example for Python SDK to upload video frames from your computer, directly into your project: upload_videos_from_folder_to_project()

sa.upload_videos_from_folder_to_project(
    project = "Project Name",
    folder_path = "./data/videos"
)

For more examples and guidance on uploading with SDK, read here.