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

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.542
File Size Uploaded Provenance Actions
forte_sdk-1.0.542.tar.gz 198.1 kB Without provenance Details for forte_sdk-1.0.542.tar.gz

Built distribution (wheel)

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

Total release size: 737.2 kB

Release files / forte_sdk-1.0.542.tar.gz

Download URL forte_sdk-1.0.542.tar.gz
Size 198.1 kB
Tags Source
SHA-256 checksum
How to use checksums
c9c052e394efeaa7ea230fb127d3aab34dba55258789e4da6e78e875a975a754
BLAKE2b-256 checksum
How to use checksums
5d424afe9af8be5c0ff70ef9c3162b583e0a5885a1caaa1844c688d68c4501ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.22

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

Download URL forte_sdk-1.0.542-py3-none-any.whl
Size 539.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
58dc8e7f97b291bfe02e0890a3e2f8b21fd821c621f1f2b64098948bf3a38acf
BLAKE2b-256 checksum
How to use checksums
50036d0a1cbb1fefe1b09b29af16d0c35c3605c739bab285cbd5945ed1fe391b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.22

Security for forte-sdk 1.0.542

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.

Release history Release notifications | RSS feed

This release

1.0.542 This release

2 release files No provenance

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