Client API

The Acme client is the entry point for all SDK interactions. Initialize it once and use it across your application.

Installation

pip install acme-sdk

Initialization

from acme import AcmeClient

# Using an API key
client = AcmeClient(
    base_url="https://acme.example.com",
    api_key="df_key_abc123..."
)

# Using OAuth token
client = AcmeClient(
    base_url="https://acme.example.com",
    token="eyJhbGciOiJSUzI1NiIs..."
)

# Using environment variables
# Reads ACME_URL and ACME_API_KEY
client = AcmeClient.from_env()

Configuration options

client = AcmeClient(
    base_url="https://acme.example.com",
    api_key="df_key_abc123...",
    timeout=30,           # Request timeout in seconds
    max_retries=3,        # Auto-retry failed requests
    retry_delay=1.0,      # Delay between retries
    verify_ssl=True,      # SSL certificate verification
)

Basic usage

List pipelines

pipelines = client.pipelines.list()

for p in pipelines:
    print(f"{p.name} — {p.status} — {p.last_run_at}")

Trigger a run

run = client.pipelines.run("user-analytics")
print(f"Run started: {run.id}")

# Wait for completion
result = run.wait()
print(f"Status: {result.status}")
print(f"Rows processed: {result.rows_loaded}")

Check pipeline status

status = client.pipelines.get("user-analytics")
print(f"Status: {status.status}")
print(f"Last run: {status.last_run_at}")
print(f"Next run: {status.next_run_at}")

JavaScript/TypeScript

import { AcmeClient } from "@acme/sdk";

const client = new AcmeClient({
  baseUrl: "https://acme.example.com",
  apiKey: process.env.ACME_API_KEY,
});

// List pipelines
const pipelines = await client.pipelines.list();

// Trigger a run
const run = await client.pipelines.run("user-analytics");
const result = await run.wait();

console.log(`Processed ${result.rowsLoaded} rows`);

Error handling

from acme.exceptions import (
    AcmeError,
    AuthenticationError,
    PipelineNotFoundError,
    RateLimitError,
)

try:
    result = client.pipelines.run("my-pipeline")
except AuthenticationError:
    print("Invalid API key")
except PipelineNotFoundError:
    print("Pipeline does not exist")
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after}s")
except AcmeError as e:
    print(f"Unexpected error: {e}")

Related

• Pipeline API — pipeline operations
• Events API — subscribe to pipeline events
• Authentication — auth setup