Skip to main content

Encord Python API Client

Encord logo

license

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

💡 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

encord-0.1.201.tar.gz (304.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

encord-0.1.201-py3-none-any.whl (383.0 kB view details)

Uploaded Python 3

File details

Details for the file encord-0.1.201.tar.gz.

File metadata

  • Download URL: encord-0.1.201.tar.gz
  • Upload date:
  • Size: 304.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for encord-0.1.201.tar.gz
Algorithm Hash digest
SHA256 ba80ba5db254fdb674f069cdff20a252508d86065395a0239024e749174238de
MD5 0f0ce5ac95b0a662f63468dc139162be
BLAKE2b-256 2d19ac3daf0870550baf6905699ced96bd9ef14a600400b541cfd6eb0cd0253e

See more details on using hashes here.

File details

Details for the file encord-0.1.201-py3-none-any.whl.

File metadata

  • Download URL: encord-0.1.201-py3-none-any.whl
  • Upload date:
  • Size: 383.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for encord-0.1.201-py3-none-any.whl
Algorithm Hash digest
SHA256 510be73c1087520c6eed07a5d116e9ebf32756bd45bde1afefca19d06c3a561c
MD5 358e265333da5b2d5c8349432237a4e7
BLAKE2b-256 a67de7d1001510b1a3d614023e1e09801846d77f9c9ff8619929aeeeaad40676

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page