Technical reference

Product concepts and technical reference

This page explains the technical surfaces behind the product. Customer setup starts with the Unreal and AI assistant guides. SDK and CLI clients use these same routes and return structured envelopes with request IDs for recovery.

Canonical files
docs/reference/api.md
docs/reference/agent-tokens.md
docs/start/repository-workflow.md
Project state

Repositories

Project name, status, branch, region, storage, bandwidth, health, and revision state.

Lore setup

Connection info

Remote URL, CLI commands, supported Lore version, and short-lived connection guidance.

Asset safety

Locks

Lock ownership, path, reason, timestamps, and status for binary asset coordination.

Movement

Transfers

Push, pull, clone, and sync status with byte totals, speed, client, and errors.

Scoped

AI access

Read-oriented assistant access with repository limits, status, scopes, action counts, and one-time secret reveal.

Short-lived

Connect tokens

Temporary credentials for Lore connection setup only. They are not broad project mutation credentials.

AI assistant scopes

Assistant access should be explicit and narrow. Connection-token creation is not granted unless the scope says so.

ScopeMeaning
repo:readRead repository metadata and status.
activity:readRead timeline events.
locks:readRead visible lock state.
summary:createRequest OpenAI-backed activity summaries when configured.
connect-token:createMint short-lived repo-scoped connect tokens; default-off for agents.

Route groups

Agent
GET /v1/agent/sessionGET /v1/agent/manifestGET /v1/agent/environment
Billing
GET /v1/billing/catalogGET /v1/orgs/:orgId/billingPOST /v1/orgs/:orgId/billing/previewPATCH /v1/orgs/:orgId/billing/subscription
Repositories
GET /v1/reposGET /v1/repos/:repoIdGET /v1/repos/:repoId/connection-info
Activity
GET /v1/repos/:repoId/activityPOST /v1/repos/:repoId/activity/summary
Locks
GET /v1/repos/:repoId/locksPOST /v1/repos/:repoId/locksDELETE /v1/repos/:repoId/locks/:lockId
Tokens
GET /v1/agent-tokensPOST /v1/agent-tokensDELETE /v1/agent-tokens/:tokenId