Skip to content

Main Navigation v0.2.0

Sidebar Navigation

Introduction

Prerequisites

Setup

Deploy

What is in the container

Prerequisites

Build and push the image

Local smoke test

Quick start on Cloud Run (evaluation)

Production on Cloud Run

Using the CLI in the container

Post-deploy administration

Health checks

Environment variable reference

Troubleshooting

Related docs

Authentication

LLM

Configuration

User access

Agent loop

Monthly limits

Usage logging

Endpoints

CLI

Global options

Commands overview

start

migrate

collection list

llm list

user

user token

Examples

API Endpoints

Overview

Conventions

Timestamps

Errors

Empty responses

Shared types

Health

GET /health

Authentication

GET /auth/session

Administration

GET /admin/users

PUT /admin/users/:id

DELETE /admin/users/:id

POST /admin/users

GET /admin/tokens

POST /admin/users/:id/tokens

DELETE /admin/tokens/:id

GET /admin/collections

GET /admin/environments

GET /admin/llm/models

Collections

GET /collections

POST /collections

PUT /collections/:id

DELETE /collections/:id

Environments

GET /environments

POST /environments

PUT /environments/:id

DELETE /environments/:id

Folders

GET /collections/:collectionId/folders

POST /collections/:collectionId/folders

PATCH /folders/:id

DELETE /folders/:id

PUT /collections/:collectionId/folders/reorder

Requests

GET /collections/:collectionId/requests

POST /collections/:collectionId/requests

PUT /requests/:id

DELETE /requests/:id

PUT /collections/:collectionId/requests/reorder

PUT /requests/:id/move

LLM routes

GET /llm/models

GET /llm/usage

POST /llm/chat/step

Development

Build

Scripts

License

On this page

Prerequisites

Node.js 24 (see .nvmrc)
pnpm 10

bash

nvm use
corepack enable

Pager

Previous pageIntroduction

Next pageSetup

Prerequisites ​

Prerequisites