Skip to main content

​
Installation

pip install terminaluse

​
Client Setup

from terminaluse import Client

client = Client(token="your-api-key")

# Async client
from terminaluse import AsyncClient

async with AsyncClient(token="your-api-key") as client:
    agent = await client.agents.retrieve("agent-id")

​
Environment Variables

VariableDescription
TERMINALUSE_API_KEYBearer token
TERMINALUSE_BASE_URLAPI endpoint (default: https://api.terminaluse.com)
# Uses TERMINALUSE_API_KEY from environment
client = Client()

​
Configuration

​
Timeout

client = Client(
    token="...",
    timeout=30.0,  # seconds
)

# Per-request override
agent = client.agents.retrieve("id", timeout=60.0)

​
Retries

client = Client(
    token="...",
    max_retries=3,  # default
)
Retries on:
  • 408 (timeout)
  • 409 (conflict)
  • 429 (rate limit)
  • 5xx (server errors)

​
Resources

The client provides access to these resources:
ResourceDescription
agentsAgent management
tasksTask management
messagesMessage operations
statesState management
eventsEvent access
filesystemsFilesystem operations
versionsVersion management
branchesBranch operations
namespacesNamespace management
projectsProject operations

​
Error Handling

from terminaluse import (
    APIError,
    AuthenticationError,
    RateLimitError,
    NotFoundError,
)

try:
    agent = client.agents.retrieve("id")
except AuthenticationError:
    print("Invalid credentials")
except RateLimitError:
    print("Rate limited")
except NotFoundError:
    print("Agent not found")
except APIError as e:
    print(f"API error: {e}")