LogoLogo
RedBrick AIGuides
  • Quick Start
    • Walkthrough Guides
    • Get Started with a Project
    • Get Started with Workspace
      • Cohort Creation
      • Datapoint Classification
      • Configuring Metadata Schema
    • Creating a RedBrick AI Account
  • Organizations
    • Organization and Project Roles
    • Inviting Your Team
      • Single Sign-on
  • Dashboard
    • Account Settings
    • User Preferences
    • Worklist
    • Preview Tool
    • Integrations
    • Taxonomies
    • Boost
      • Auto Annotator
    • Home
      • Sections
  • Importing Data
    • Uploading Data to RedBrick
    • Import Cloud Data
      • Configuring AWS s3
      • Configuring Azure Blob
      • Configuring GCS
      • Configuring AltaDB
      • Creating an Items List
    • Troubleshooting
  • Projects
    • Tasks & Assignment
    • Comments & Raise Issue
    • Reference Standards
    • Project & Task Analytics
    • Labeler Evaluation
  • Project Pages
    • Data Page
    • Settings Page
      • Custom Label Validation
      • Custom Hanging Protocol
      • Webhooks
    • Multiple Labeling
      • Consensus
        • Agreement calculation
      • Task duplication
  • Annotation & viewer
    • Viewer Basics
      • Document Viewer
      • Multiple Modalities
      • Intellisync
      • Annotation Mirroring
    • Creating, Editing and Deleting Annotations
    • Visualization and Masking
    • Segmentation
      • Segmentation Tools
      • Instance vs. Semantic
      • Overlapping Segmentations
    • Heat maps
  • Python SDK & CLI
    • Full documentation
    • Installation & API Keys
    • SDK Overview
      • Importing Data & Annotations
      • Programmatic Label & Review
      • Assigning & Querying Tasks
      • Exporting Annotations
    • CLI Overview
      • Creating & Cloning Projects
      • Import Data & Annotations
      • Exporting Annotations
    • Importing Annotations Guide
    • Formats
      • Full Format Reference
      • Export Structure
  • Useful Links
    • Privacy Policy
Powered by GitBook
On this page
  • Installation
  • API Keys
  • Organization and Project IDs

Was this helpful?

  1. Python SDK & CLI

Installation & API Keys

PreviousHeat mapsNextSDK Overview

Last updated 5 months ago

Was this helpful?

Installation

The RedBrick AI SDK and CLI are available on and can be installed using pip. The SDK and CLI are packaged together.

$ pip install -U redbrick-sdk

The SDK and CLI work on Mac, Windows, and Linux.

They are compatible with python version 3.8+

API Keys

In order to use the Python SDK or CLI, you'll first need to generate an API key. To do so:

  1. Click on Integrations (or use the "i" shortcut)

  2. Click on API Keys (or use the "2" shortcut)

  3. In the top right corner, click on Create API Key

  4. In the pop-up field, give your API key a name

After you've generated your API key, you can copy it to wherever is necessary - your CLI credentials file, your Python file, etc.

Organization and Project IDs

For most SDK / CLI operations, you will need your Organization and/or Project ids. These are unique ids for each entity. You can find both the Organization and Project ID inside the Settings Page of any Project.

You can also find the Organization and Project IDs within the browser URL -> head over to any project - https://app.redbrickai.com/<org_id>/projects/<project_id>.

Please note that all API keys provide the user with the equivalent of . Be sure to use your API keys with care!

PyPI
Org Admin permissions
The Integrations tab
The API Keys page