Forte Platforms Python SDK

Official Python SDK for interacting with the Forte Platforms API.

Installation

pip install forte-sdk

Authentication

The SDK supports three auth modes.

Inside a Forte-hosted service (no config)

FORTE_API_TOKEN is set automatically and scoped to the service's project:

client = ForteClient()

Server-side BFF calling `client.users.*` (no token, per-call authorization)

When proxying user-scoped calls from a BFF, omit the token and pass each user's session token as the authorization parameter on each call:

client = ForteClient()
client.users.renew_session_token(
    project_id=project_id,
    authorization=f"Bearer {user_session_token}",
)

External server-side calling `client.projects.*` (explicit token)

client = ForteClient(api_token="your_api_token_here")

Or set FORTE_API_TOKEN in the environment and call ForteClient().

You can generate an API token from the Forte Platforms dashboard.

Quick Start

from forte_sdk import ForteClient

client = ForteClient()

# List your projects
projects = client.projects.list_projects()

# Get a specific project
project = client.projects.get_project(project_id="your-project-id")

Error Handling

API errors are raised as exceptions:

from forte_sdk.generated.exceptions import ApiException

try:
    project = client.projects.get_project(project_id="invalid-id")
except ApiException as e:
    print(f"API error {e.status}: {e.reason}")

User Custom Attributes

Store arbitrary key-value metadata on your users. Useful for tracking subscription tiers, feature flags, preferences, or any application-specific data.

# Set custom attributes on a user
user = client.projects.put_user_custom_attributes(
    project_id="your-project-id",
    user_id="user-id",
    request_body={
        "plan": "pro",
        "referral_source": "google",
        "onboarding_completed": "true",
    },
)

print(user.custom_metadata_attributes)
# {'plan': 'pro', 'referral_source': 'google', 'onboarding_completed': 'true'}

Key constraints:

Keys must be 1-64 characters: letters, numbers, underscores, and hyphens only
Values are strings
Each call replaces all existing attributes — include any you want to keep

Merge with existing attributes

# Read current attributes, then merge
user = client.projects.get_project_user(
    project_id="your-project-id",
    user_id="user-id",
)

client.projects.put_user_custom_attributes(
    project_id="your-project-id",
    user_id="user-id",
    request_body={
        **user.custom_metadata_attributes,
        "plan": "enterprise",  # update one field
    },
)

API Reference

`client.projects`

Manage projects and services on Forte Platforms.

`client.users`

Manage end-users within your projects.

Metadata

Release files for forte-sdk 1.0.384

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

Source distribution (sdist)

Source distribution for forte-sdk 1.0.384
File	Size	Uploaded
forte_sdk-1.0.384.tar.gz	147.9 kB	Sep 11, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for forte-sdk 1.0.384
File	Interpreter	ABI	Platform	Reset
forte_sdk-1.0.384-py3-none-any.whl 402.0 kB Sep 11, 2026	Python 3	none	any	Details

Total release size: 549.9 kB

Release files / forte_sdk-1.0.384.tar.gz

Download URL	forte_sdk-1.0.384.tar.gz
Size	147.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`f25ef9e2b5018f156aeed25d75a1eb57be88ad48cbb2c5c79c07385d3491381e`
BLAKE2b-256 checksum How to use checksums	`f72a3746e7b3f4bded7fd17bd9933195b45fbb2bc98b0646181c2f10f586f1e8`
Upload date	Sep 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.10.21`

Release files / forte_sdk-1.0.384-py3-none-any.whl

Download URL	forte_sdk-1.0.384-py3-none-any.whl
Size	402.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c74981c4ab23c209301ff70d9242071e637f6341124b2fd1493b600b59b39703`
BLAKE2b-256 checksum How to use checksums	`83ecf4585ead54692760c929f07daaa2b190c4c086ece57484e8ddb1d6130237`
Upload date	Sep 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.10.21`