API Reference

The API for orchestration

The Alpheric REST API to orchestrate Atlas models, agents, knowledge, and workflows from a single endpoint — typed, streamable, and governed, with SDKs that get you to production fast.

Built for developers

An API you can trust

Designed for production from day one — predictable, versioned, and secure.

Single endpoint, every model

One request routes automatically to the right Atlas model for the task.

Streaming responses

Token-level server-sent events for real-time, low-latency experiences.

Scoped API keys

Granular, revocable keys with per-key rate limits and audit trails.

Versioned and stable

Date-pinned API versions so integrations never break underneath you.

Predictable limits

Clear rate limits with headers and idempotency keys on every write.

Webhooks and events

Subscribe to run, agent, and workflow events with signed payloads.

Authentication

Authenticate with a bearer token

Every request is authenticated with a scoped API key sent as a bearer token. Keys are revocable, rate-limited per key, and never expire silently — rotate them anytime from the dashboard or the Auth endpoint.

Bearer authScoped keysPer-key limitsRotatable
request.sh
curl https://api.alpheric.ai/v1/models/run \
  -H "Authorization: Bearer $ALPHERIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "auto",
    "input": "Summarize Q3 revenue risks.",
    "context": ["knowledge:finance"]
  }'
Code sample

Stream a workflow in a few lines

The TypeScript SDK wraps auth, retries, and streaming so you can focus on the product. Run a workflow, stream tokens as they arrive, and inspect which Atlas model handled the request.

workflow.ts
import { Alpheric } from "@alpheric/sdk";

const client = new Alpheric({
  apiKey: process.env.ALPHERIC_API_KEY,
});

// Run a workflow and stream the result
const stream = await client.workflows.run({
  workflow: "support-triage",
  input: { message: "My March invoice looks wrong." },
  stream: true,
});

for await (const event of stream) {
  if (event.type === "token") process.stdout.write(event.text);
  if (event.type === "done") console.log("\nrouted:", event.routedModel);
}
SDKs and tools

Build in your stack

Official libraries and tooling so you can start in the language you already use.

TypeScript

Fully typed client for Node and the browser, published on npm.

Python

Idiomatic, async-ready SDK with helpers for streaming and retries.

CLI

Run workflows, manage keys, and tail logs straight from your shell.

Postman

Import the full collection and start sending requests in seconds.

// Get Started

Ready to build smarter?

One secure platform for AI models, agents, and enterprise workflows.
Live in days, not months. No vendor lock-in.

200+Enterprise Deployments
99.9%SLA Uptime
6Atlas Models
AES-256Encryption at rest