Quick Start

Prerequisites

brew install just protobuf

You also need Rust stable (1.75+) and Docker installed.

Start Infrastructure

# Start Postgres + Ollama + Whisper
just infra-up

# Build Docker tool images (ffmpeg, whisper, yt-dlp, python-ml)
just docker-build-tools

# Configure environment
cp .env.example .env

Run the Control Plane

just run

The server starts on 127.0.0.1:3001.

Start the Executor (separate terminal)

just executor

The executor connects to Postgres and begins claiming workflow steps for execution.

Verify It Works

TypeScript

import { FabricClient } from "@fabric-platform/sdk";

const fabric = new FabricClient();

// List available AI providers
const providers = await fabric.listProviders();
console.log(providers);

Python

from fabric_platform import FabricClient

fabric = FabricClient()

# List available AI providers
providers = fabric.list_providers()
print(providers)

Rust

use fabric_sdk::FabricClient;

let client = FabricClient::new("http://localhost:3001", "")?;
let providers = client.list_providers().await?;
println!("{:?}", providers);

curl

# Health check
curl http://localhost:3001/healthz

# List available AI providers
curl http://localhost:3001/v1/providers

Create Your First Resources

Create an Organization

TypeScript

const org = await fabric.createOrganization({
  slug: "acme",
  name: "Acme Corp",
});

Python

org = fabric.create_organization(slug="acme", name="Acme Corp")

Rust

let org = client.create_organization("acme", "Acme Corp").await?;

curl

curl -X POST http://localhost:3001/v1/organizations \
  -H 'content-type: application/json' \
  -d '{"slug":"acme","name":"Acme Corp"}'

Submit a Job

TypeScript

const job = await fabric.createJob({
  modality: "text",
  input: { prompt: "Hello from Fabric" },
  organizationId: org.id,
});
console.log("Job:", job.id, job.status);

Python

job = fabric.create_job(
    modality="text",
    input={"prompt": "Hello from Fabric"},
    organization_id=org["id"],
)
print("Job:", job["id"], job["status"])

Rust

let job = client.create_job(serde_json::json!({
    "modality": "text",
    "input": {"prompt": "Hello from Fabric"},
    "organization_id": org.id
})).await?;
println!("Job: {} {}", job.id, job.status);

curl

curl -X POST http://localhost:3001/v1/jobs \
  -H 'content-type: application/json' \
  -d '{
    "modality": "text",
    "input": {"prompt": "Hello from Fabric"},
    "organization_id": "<org-id>"
  }'

Stream Events

TypeScript

await fabric.streamEvents((event) => {
  console.log(event.kind, event.payload);
});

Python

for event in fabric.stream_events():
    print(event["kind"], event.get("payload"))

Rust

let mut stream = client.stream_events().await?;
while let Some(event) = stream.next().await {
    println!("{} {:?}", event.kind, event.payload);
}

curl

curl -N http://localhost:3001/v1/events/stream

What’s Next?

• Configuration — Learn about all CLI flags, environment variables, and Docker profiles
• Local Models — Set up Ollama, Whisper, and OpenAI-compatible servers
• API Examples — Explore the full API with curl examples
• Architecture Overview — Understand the control plane and execution plane