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.
1 maintainer
Metadata
1 maintainer
Release files for forte-sdk 1.0.342
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| forte_sdk-1.0.342.tar.gz | 138.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| forte_sdk-1.0.342-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 515.1 kB
Release files / forte_sdk-1.0.342.tar.gz
| Download URL | forte_sdk-1.0.342.tar.gz |
|---|---|
| Size | 138.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
581a05a457ecba4935e6fe0eacb8691e792413d3f5a2a5f5ca9bbeb4fece0725
|
|
BLAKE2b-256 checksum How to use checksums |
aee67bf7707b0e3db3aa2de4927bb9d6e059e937a04a41d5d04585f8e7f82523
|
| 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.342-py3-none-any.whl
| Download URL | forte_sdk-1.0.342-py3-none-any.whl |
|---|---|
| Size | 376.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f98d78bdb998dd05444ef059596a77e4e5154dc3878febe452b860051598aaa7
|
|
BLAKE2b-256 checksum How to use checksums |
930035de5cf895dc985bbe4fbfe8f139dd2a91bc9838f9d74158d641ceeda5cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.20
|
