Skip to main content

The standard API for egocentric data. $1/hr.

Project description

BuildAI Python SDK

Python client for Build AI services.

Install

cd apps/buildai-sdk
uv pip install -e .

Quick Start

import buildai

client = buildai.Client(api_key="bai_...")

# Search
hits = client.search("person welding")
for h in hits.data:
    print(h.clip_id, h.score)

# Browse
factories = client.factories.list()
clip = client.clips.get("clip-uuid")
streams = client.sessions.streams("session-uuid")

datasets = client.datasets.list()

client.close()

If api_key= is omitted, the SDK first checks BUILDAI_TOKEN (or BUILDAI_API_KEY), then falls back to the CLI credential stored by buildai login in ~/.buildai/credentials.json.

Modes

The SDK has two modes:

  • mode="public" is the default and targets the public /v1 contract
  • mode="internal" unlocks internal-only resources when your credential is allowed to use them

Important:

  • both modes use the same /v1 API prefix
  • the distinction is authorization and exposed resource set, not a separate base URL

Dataset Surface

Use client.datasets for the canonical public dataset surface. For the underlying storage model, read ../../specs/architecture/data-model.md.

Package Layout

  • buildai/client.py — Client entry point
  • buildai/resources/v1/ — Resource namespaces
  • buildai/models/v1/ — Response models
  • buildai/ids.py — Deterministic UUID helpers

Project details


Download files

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

Source Distribution

buildai_sdk-0.1.0.tar.gz (154.3 kB view details)

Uploaded Source

Built Distribution

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

buildai_sdk-0.1.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file buildai_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: buildai_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 154.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for buildai_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 41b9f436eea09a4d5604a8605d6242017b208035f4c35d855d2ff80d51b14f28
MD5 8cc0b0e9515ef9e235b513178f67df11
BLAKE2b-256 f3267d5d7e65356e592196e13f200fb6bee4a0c61b766ee046c2fe81ff5a7f07

See more details on using hashes here.

File details

Details for the file buildai_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: buildai_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for buildai_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d51b60cd7d1f5c66987d5bb6a262b504b68ca20928ca5215e25ae28fab90e625
MD5 605b512452c481d9259ba3cc6fa24d1b
BLAKE2b-256 ab0f1f9719423e0c3ec3278182b27be971d74f751929a2466e1bc7d43c5d9825

See more details on using hashes here.

Supported by

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