Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.redbrickai.com/llms.txt

Use this file to discover all available pages before exploring further.

The RedBrick AI Python SDK is a Python package that allows you to interact with the RedBrick AI application programmatically. We recommend you use the Python SDK if you want to: For simple data import and annotation export, we recommend you use the CLI, which has a simple interface with optimizations for basic use cases.

CLI Overview
This SDK documentation is intended to cover high-level guides and use cases. If you are interested in more detailed documentation of the SDK interface, please visit the full SDK reference documentation.

​
Initializing the RedBrick SDK in Python

Nearly all operations with the SDK are performed on either the Project or Organization objects. Browser-based login is the recommended authentication method. It is more secure than API keys and supports single sign-on (SSO). 
import redbrick

# Opens your browser to authenticate
redbrick.login()

# After logging in, no api_key is needed
project = redbrick.get_project(
    org_id="...",
    project_id="...",
)
organization = redbrick.get_org(
    org_id="...",
)

​
API Key Authentication

You can also authenticate using an API key. Note that API keys will be sunset in favor of service accounts in a future release. You will see a warning when using API key authentication. 
import redbrick

project = redbrick.get_project(
    org_id="...",
    project_id="...",
    api_key="...",
)
organization = redbrick.get_org(
    org_id="...",
    api_key="...",
)
Both redbrick.get_project and redbrick.get_org take an optional url argument that defaults to https://api.redbrickai.com. If you are using a private/single-tenant deployment of RedBrick AI, this will need to be changed for your deployment - reach out to us for confirmation of what your case-specific URL needs to be.