octospark-sdk 0.1.0

Generated Python SDK for the Octospark public API.

octospark-sdk

Generated Python SDK for the Octospark public API.

The SDK uses the same OpenAPI document as the Octospark API reference and defaults to https://api.octospark.ai.

Install

pip install octospark-sdk

Authentication

Create an API key in Octospark from Organization settings, API Keys.

Store it as OCTOSPARK_TOKEN and pass it to the SDK:

export OCTOSPARK_TOKEN="octo_live_..."

Full guide: https://docs.octospark.ai/authentication

Usage

import os

from octospark_sdk import OctosparkApiError, OctosparkClient

octospark = OctosparkClient(token=os.environ["OCTOSPARK_TOKEN"])

try:
    organizations = octospark.organizations_list_organizations(query={"limit": 1})
    print(organizations["data"][0])
except OctosparkApiError as error:
    print(error.status, error.body)

Staging

The SDK defaults to production. To target staging, pass base_url:

octospark = OctosparkClient(
    base_url="https://api-staging.octospark.ai",
    token=os.environ["OCTOSPARK_TOKEN"],
)

Documentation

• Get started: https://docs.octospark.ai/start
• SDKs: https://docs.octospark.ai/sdks
• Authentication: https://docs.octospark.ai/authentication
• API reference: https://docs.octospark.ai/api-reference/organizations/list-organizations
• OpenAPI document: https://docs.octospark.ai/openapi.json