Skip to content

Python SDK Client Setup

Initialize and configure the Enterprise API client for your Python application.

Basic Initialization

Create a client with just your API key:

from gridbank_api import EnterpriseClient

client = EnterpriseClient(api_key="apik_your_key_here")

Get your API key: Contact support@gridbank.io — keys are provisioned manually during onboarding.

Configuration Options

Customize client behavior with advanced options:

client = EnterpriseClient(
    api_key="apik_your_key_here",
    base_url="https://api2.gridbank.io",  # Default API endpoint
)

Never hardcode API keys. Store them in environment variables:

# .env file or export in terminal
export GRIDBANK_API_KEY="apik_your_key_here"

Load from environment:

import os
from gridbank_api import EnterpriseClient

api_key = os.getenv("GRIDBANK_API_KEY")
if not api_key:
    raise ValueError("GRIDBANK_API_KEY environment variable not set")

client = EnterpriseClient(api_key=api_key)

Error Handling

All SDK methods raise EnterpriseAPIError on API errors. Handle them gracefully:

from gridbank_api import EnterpriseClient, EnterpriseAPIError

client = EnterpriseClient(api_key="apik_...")

try:
    results = client.search_videos(q="test")
except EnterpriseAPIError as e:
    print(f"HTTP {e.status_code}: {e.message}")
    if e.details:
        print(f"Details: {e.details}")

See Error Handling Guide for detailed error information.

Type Hints & IDE Support

The SDK provides full type hints for excellent IDE autocomplete:

from gridbank_api import EnterpriseClient, VideoListResponse, Video

client = EnterpriseClient(api_key="apik_...")

# Full type support
results: VideoListResponse = client.search_videos(q="nature", per_page=5)

# IDE knows about all Video properties
for video in results.videos:
    print(f"{video.title} by {video.creator.name}")

Next Steps