Table of Contents

Getting started

Alex Cota Updated by Alex Cota

Overview

The Python SDK allows you to access all of the functionalities of the Labelbox API without having to use GraphQL. This documentation guides you through installation, setup, and some common use cases.

See the Python SDK repo in Github.

We released v2.4.7 on September 10, 2020. Run pip install --upgrade labelbox to upgrade (please consult the Changelog before upgrading). The Python SDK supports Python versions 3.6 and 3.7.

Installation & authentication

Step 1 Create your API key

You must have an API key for authentication. For instructions on creating a key, see API keys.

Step 2 Install

Install Labelbox using pip.

user@machine:~$ pip install labelbox
Step 3 Authenticate

In the command line, pass your API key as an environment variable and open the Python interpreter.

user@machine:~$ export LABELBOX_API_KEY="<your_api_key>"
user@machine:~$ python3

Then, import and initialize the API Client.

from labelbox import Client
client = Client()

Passing in a custom endpoint is only applicable for on-premises use cases. If this applies to you, you may pass the API key and server endpoint explicitly when you initialize the Client object. Otherwise, refer to the step above.

from labelbox import Client
client = Client("<your_api_key_here>", "https://app.your-domain.com/api/graphql")

Here is a Python snippet you can also use to connect to the API. Run this as a python script and pass your API key as a string.

from labelbox import Client

if __name__ == '__main__':
    API_KEY = "<your_api_key_here>"
    client = Client(API_KEY)
Step 4 Create a project

For a step-by-step guide for creating a basic project, see Creating your first project.

For a full end-to-end Python code sample for setting up a complete project in Labelbox, see Project setup script.

Was this page helpful?

Creating your first project

Contact