Python SDK

Install and use the official Pivot Python SDK generated from the Pivot REST OpenAPI spec.

The Pivot Python SDK provides typed request/response models and endpoint helpers for the Pivot REST API. It is generated from the same OpenAPI document used by the REST API reference, so client updates can be produced with code generation instead of manual endpoint wiring.

Installation

pip install hellopivot-sdk

If you use uv in your own project:

uv add hellopivot-sdk

Quick start

import os

from hellopivot_sdk import AuthenticatedClient
from hellopivot_sdk.api.spaces import get_spaces_by_organization_id

client = AuthenticatedClient(
    base_url="https://api.pivot.app",
    token=os.environ["PIVOT_API_KEY"],
)

with client as authenticated_client:
    response = get_spaces_by_organization_id.sync(
        organization_id="your-org-id",
        offset=0,
        client=authenticated_client,
    )
    print(response)

The SDK uses Authorization: Bearer <API_KEY> automatically through AuthenticatedClient.

API organization

Endpoint modules are grouped by REST API tags:

• hellopivot_sdk.api.blocks
• hellopivot_sdk.api.groups
• hellopivot_sdk.api.invites
• hellopivot_sdk.api.labels
• hellopivot_sdk.api.rooms
• hellopivot_sdk.api.spaces
• hellopivot_sdk.api.users
• hellopivot_sdk.api.webhooks

Each endpoint module provides:

• sync and sync_detailed for blocking calls
• asyncio and asyncio_detailed for async calls

Requirements

• Python 3.10+
• API key from your Pivot integration