Skip to main content

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.345

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.345
File Size Uploaded
forte_sdk-1.0.345.tar.gz 141.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for forte-sdk 1.0.345
File Interpreter ABI Platform
forte_sdk-1.0.345-py3-none-any.whl Python 3 none any Details

Total release size: 525.5 kB

Release files / forte_sdk-1.0.345.tar.gz

Download URL forte_sdk-1.0.345.tar.gz
Size 141.3 kB
Tags Source
SHA-256 checksum
How to use checksums
db3ba2143c3a1b8dc3b442d1531ad2c8098d61280b05822887f8b8f3a2d34796
BLAKE2b-256 checksum
How to use checksums
c1b925293ebe423e412942a11109ebb115444e7e39200e7042f7ac7f5830e79e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.20

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

Download URL forte_sdk-1.0.345-py3-none-any.whl
Size 384.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
81134efa45dc1291683c2dcca167437dd90412e006e0cdcab2d61a06f5818dee
BLAKE2b-256 checksum
How to use checksums
b4af0b85d58528e0418b1147ba2e32135ef770ca57106eb1d46368bffacc3917
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.20

Release history Release notifications | RSS feed

This release

1.0.345 This release

2 release files

1.0.68

2 release files

1.0.61

2 release files

1.0.60

2 release files

1.0.57

2 release files

1.0.55

2 release files

1.0.53

2 release files

1.0.48

2 release files

1.0.45

2 release files

1.0.28

2 release files

1.0.24

2 release files

1.0.20

2 release files

1.0.17

2 release files

1.0.13

2 release files

1.0.9

2 release files

1.0.8

2 release files

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