Encord Python API Client

Encord is the multimodal data layer for physical AI. Manage, curate, annotate, and align petabytes of data - from sensor streams to video to text.

💻 Features

• Minimal low-level Python client that allows you to interact with Encord's API
• Supports Python: 3.9, 3.10, 3.11, 3.12, 3.13 and 3.14

✨ Relevant Links

• Encord website
• Encord web app
• Encord documentation

💡 Getting Started

For full documentation, please visit Encord Python SDK.

First, install Encord Python API Client using the pip package manager:

python3 -m pip install encord

Some functionality is available through optional extras. Install them if you need COCO import/export or MCAP support:

# COCO import/export helpers (pycocotools, shapely, opencv, numpy)
python3 -m pip install "encord[coco]"

# MCAP support (mcap, protobuf, Pillow)
python3 -m pip install "encord[mcap]"

Then, create a service account, generate a key pair, and register the public key in the Encord platform. Detailed guide can be found in the dedicated manual.

Pass the path to your private key when initializing the Encord client:

# Import dependencies
from encord import EncordUserClient

# Authenticate with Encord using the path to your private key.  Replace <private_key_path> with the path to your private key.
user_client = EncordUserClient.create_with_ssh_private_key(
  ssh_private_key_path="<private_key_path>"
)

For detailed example code and SDK reference material refer to Encord SDK documentation

🐛 Troubleshooting

Please report bugs to the GitHub Issues. Just make sure you read the Encord documentation and search for related issues first.