Getting Started

Quick Start

The Auboz API lets you manage knowledge base workspaces, upload documents, and query them with AI.

Service	Base URL	Purpose
REST API	`https://api.auboz.com`	Workspaces, documents, users, sessions
Agent	`https://agent.auboz.com`	AI-powered search (SSE streaming)

1. Get an API Key

Create an API key in Settings → Developer. Select the scopes you need (e.g., kb:read, kb:write, chat:write).

2. Make Your First Request

List your workspaces

curl https://api.auboz.com/v1/kb/workspaces \
  -H "Authorization: Bearer sk_your_api_key"

3. Query Your Knowledge Base

The agent endpoint streams responses via Server-Sent Events (SSE):

Ask the AI agent (streaming)

curl -N -X POST https://agent.auboz.com/agent/stream \
  -H "Authorization: Bearer sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "What are the key findings?",
    "workspaceIds": ["your-workspace-id"]
  }'

Code Examples

Python

import requests
import sseclient
import json

API_KEY = "sk_your_api_key"
BASE = "https://api.auboz.com/v1"
headers = {"Authorization": f"Bearer {API_KEY}"}

# List workspaces
workspaces = requests.get(f"{BASE}/kb/workspaces", headers=headers).json()

# Query the AI agent (SSE streaming)
response = requests.post(
    "https://agent.auboz.com/agent/stream",
    headers={**headers, "Content-Type": "application/json"},
    json={
        "message": "Summarize the main points",
        "workspaceIds": [workspaces[0]["id"]],
    },
    stream=True,
)

client = sseclient.SSEClient(response)
for event in client.events():
    data = json.loads(event.data)
    if data["type"] == "token":
        print(data["content"], end="", flush=True)
    elif data["type"] == "done":
        print(f"\nCredits used: {data['creditsUsed']}")

TypeScript

const API_KEY = "sk_your_api_key";
const BASE = "https://api.auboz.com/v1";
const headers = { Authorization: `Bearer ${API_KEY}` };

// List workspaces
const workspaces = await fetch(`${BASE}/kb/workspaces`, { headers })
  .then(r => r.json());

// Query the AI agent (SSE streaming)
const response = await fetch("https://agent.auboz.com/agent/stream", {
  method: "POST",
  headers: { ...headers, "Content-Type": "application/json" },
  body: JSON.stringify({
    message: "Summarize the main points",
    workspaceIds: [workspaces[0].id],
  }),
});

const reader = response.body!.getReader();
const decoder = new TextDecoder();
while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  for (const line of decoder.decode(value, { stream: true }).split("\n")) {
    if (!line.startsWith("data: ")) continue;
    const data = JSON.parse(line.slice(6));
    if (data.type === "token") process.stdout.write(data.content);
    if (data.type === "done") console.log(`\nCredits: ${data.creditsUsed}`);
  }
}

Base URLs

Service	Base URL
REST API	`https://api.auboz.com`
Agent (SSE)	`https://agent.auboz.com`

HTTPS is required. HTTP connections are refused. TLS 1.2 minimum.