Skip to main content

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 ../../docs/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

Metadata

Release files for buildai-sdk 2.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for buildai-sdk 2.3.0
File Size Uploaded Provenance
buildai_sdk-2.3.0.tar.gz 172.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for buildai-sdk 2.3.0
File Interpreter ABI Platform
buildai_sdk-2.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 216.1 kB

Release files / buildai_sdk-2.3.0.tar.gz

Download URL buildai_sdk-2.3.0.tar.gz
Size 172.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3af6bc05bbef089945564e60fcb60b7c1e7f7105d893355e27d30a5f77f143e5
BLAKE2b-256 checksum
How to use checksums
93cb574a3f51ccdd7715eed1267d0798ce1bebd85333d29d243b929363996868
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / buildai_sdk-2.3.0-py3-none-any.whl

Download URL buildai_sdk-2.3.0-py3-none-any.whl
Size 43.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7bed9f5900e4581fc7d9b087f1f7316784ef5c3871a7cf4cb06d4182f36bd35d
BLAKE2b-256 checksum
How to use checksums
523f16c810c6523311a21063d9e2b5305e84d5eed8ea164589172b3cf49248eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for buildai-sdk 2.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page