Quickstart Guide

This guide walks through the current proxy contract that fronts the upstream gateway.

Privacy AI Infrastructure

Build secure agentic memory enclaves

Provision dedicated Cloudflare R2 vaults and vector spaces for your local-first AI applications. Connect standard SDK clients with secure access tokens.

Get API Access

1. Get a Bearer Token

Send requests with Authorization: Bearer <token>. The proxy can resolve Firebase ID tokens, Omni dev tokens, Omni API keys, and local mock tokens depending on the route.

2. Create a Workspace

Start by creating a workspace through the modern PKMS surface:

curl -X POST https://api.llm.ovh/v1/workspaces \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Workspace"
  }'

3. Create a Unified Document

The modern document API accepts plaintext payloads and stores the canonical PKMS document record.

curl -X POST https://api.llm.ovh/v1/documents \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "ws-123",
    "title": "Meeting Notes",
    "document_payload": {
      "format": "omni.om",
      "title": "Meeting Notes",
      "type": "document"
    },
    "blocks_payload": [
      {
        "id": "block-1",
        "type": "text",
        "content": "Met with the team."
      }
    ],
    "markdown": "# Meeting Notes\nMet with the team.",
    "indexable_blocks": [
      {
        "id": "block-1",
        "type": "text",
        "content": "Met with the team."
      }
    ],
    "metadata": {
      "source": "quickstart"
    }
  }'

4. Query Documents

Search uses the modern query route:

curl -X POST https://api.llm.ovh/v1/documents/query \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "ws-123",
    "query": "meeting team",
    "top_k": 5,
    "include": {
      "notes": true,
      "memories": true,
      "files": false
    }
  }'

5. Legacy compatibility note

The current desktop client still uses legacy note routes for CRUD, but new clients should prefer the modern /v1/documents and /v1/workspaces/:workspaceId/documents surface.

Use these references for exact details:

Now you are ready to build against the current proxy contract directly.