Forra SDK Package

Helper python package to interact with the Forra platform.

Installation

pip install forrasdk

The default installation includes the API client and CLI without installing openpyxl. To use forrasdk.spreadsheets or forrasdk.shared.spreadsheets, install the optional spreadsheet dependencies:

pip install "forrasdk[spreadsheets]"

Usage

from forrasdk import ForraAPI

forra = ForraAPI(base_url="your_forra_base_url", api_access_token="you_api_access_token")

Retry Logic

The SDK automatically retries failed API requests with exponential backoff to handle transient failures. This improves reliability when dealing with network issues or temporary server problems.

Default Behavior

• Max attempts: 3 (initial request + 2 retries)
• Wait time: Exponential backoff with multiplier=1, min=4s, max=10s
• Retry on:
  • Rate limiting (429)
  • Server errors (500, 502, 503, 504)
  • Network errors (ConnectionError, Timeout)
• Does NOT retry on:
  • Client errors (400, 401, 403, 404, etc.)
  • Successful responses

How It Works

All HTTP methods (GET, POST, PUT, DELETE, PATCH) in the SDK automatically retry on transient failures:

from forrasdk import ForraAPI

forra = ForraAPI(base_url="your_url", api_access_token="your_token")

# This request will automatically retry up to 3 times on 5xx errors
response = forra.chat.completion(messages="Hello!")

The retry logic is transparent - you don't need to change your code. If a request fails with a retryable error, the SDK will:

1. Wait with exponential backoff (4s, then 8s, then 10s max)
2. Retry the request
3. Return the result if successful, or raise the exception after exhausting retries