Developer Guide

Comprehensive resource to help you build applications, integrate with Tator’s API, and extend Tator’s functionality.

🚀 Getting Started

Essential first steps for developers new to Tator.

Install tator-py

Install the Python client library

Get an API Token

Authenticate with Tator’s API

Tator Data Concepts

Understand Tator’s data model

Using the Swagger UI

Explore the REST API interactively

📁 Project & Media Management

Programmatically manage projects, upload media, and organize data.

Create a Project with Python

Set up new projects via API

Upload Media with Python

Batch upload videos and images

Download Media

Programmatically download media files

Import Hosted Media

Import media from external URLs

Create Multi-stream Videos

Work with synchronized video streams

Local Transcodes

Process videos locally before upload

Attach Files to Media

Associate additional files with media

Nested Folders with Python

Organize media in folder hierarchies

Using the Changelog

Track changes to your data

Archive Uploads

Manage upload archives

Archive and Restore Media with Python

Implement data lifecycle management

Extract Frames and Video Clips

Export video segments programmatically

Extract Localization Images and Track Animations

Generate crops and animations from annotations

Migrate Data

Transfer data between Tator instances

🏷️ Working with Annotations

Create, manage, and analyze annotations programmatically.

Entities and Attributes

Understand Tator’s annotation data model

Create Annotations

Add annotations via API

Create Localizations without Geometry

Create frame-level annotations

Define a Label Tree

Set up hierarchical labeling systems

Labeling Activities

Annotate temporal events and activities

🤖 Reports & Algorithms

Integrate machine learning and automated analysis workflows.

Register an Algorithm

Add custom processing algorithms

Launch Algorithms with Python

Execute algorithms programmatically

AI-assisted Annotation

Implement machine learning workflows

📊 Applets & Dashboards

Create custom interfaces and visualization tools.

Create Analytics Dashboards

Build custom data visualizations

Canvas Applets

Develop interactive canvas-based tools

Create Annotator Menu Applets

Add custom tools to the annotation interface

Hosted Templates

Use pre-built dashboard templates

🛠️ Contributing to Tator

Help improve Tator by contributing to the open source project.

Using the Tator Build System

Set up the development environment

Run Unit Tests

Test your contributions

Looking for user instructions? Check out our User Guide. Need help with deployment? See our Administrator Guide.