SDK Overview

The RedBrick AI Python SDK is a Python package that allows developers to interact with the RedBrick AI application programmatically. 
We recommend you use the Python SDK if you:
Build data pipelines with Python and want to integrate your RedBrick AI annotation.
Want to write advanced scripts beyond simple import & export. 
For simple data import and annotation export, we recommend you use the CLI, which has a simple interface with optimizations for the basic use cases. 
CLI Overview
This documentation covers 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
Almost all operations with the SDK are performed on either the Project or Organization objects. You can instantiate these objects using your API Key, Org ID, and Project ID. 
import redbrick
​
api_key = "..."
org_id = "..."
project_id = "..."
​
project = redbrick.get_project(
    org_id=org_id,
    project_id=project_id,
    api_key=api_key,
)
organization = redbrick.get_org(
    org_id=org_id, 
    api_key=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 on the URL needs to be.
Last modified 5mo ago