Runlog docs

Start building

A plan buys a weekly allowance, sized for steady work.

Start

Workflows through the API

The five walks in Core functionality, composed from routes. Every step names a route that serves today and links to its card; a step whose route takes the signed-in session rather than a key says so, because a headless caller has no session and needs to know where the app’s own hands are still required.

01

Keep a directory read

What `runlog link`, `sync` and `watch` do from a terminal, and the desktop app does behind Link, from your own process against a project your customer never sees.

  1. 1.GET/v1/api/workspace/describeAPI keyRead the binding: which project this key opens and what it already holds.
  2. 2.GET/v1/api/workspace/manifestAPI keyList what the project holds, so the diff is computed on your side.
  3. 3.POST/v1/api/workspace/quoteAPI keyPrice the reading before anything uploads; free, and the number to show a person.
  4. 4.POST/v1/api/workspace/syncAPI keyPush the files that changed; an in-flight file runs to completion.
  5. 5.POST/v1/api/workspace/reconcileAPI keyDrop what is gone locally, so a deleted file stops being cited.

YieldsA project that mirrors a directory, at declaration grain for code and by kind for everything else.

02

Ask with citations

The answer with source chips under it: what Ro gives in the thread and what Claude Code gets through the MCP server.

  1. 1.POST/v1/api/actionsAPI keySearch the spine with a question; the answer carries the cell ids it rested on.
  2. 2.POST/v1/api/actionsAPI keyFor code: a pack of declarations sized to a token budget, each with its span.
  3. 3.GET/v1/projects/{projectId}/cellsAPI keyOpen a cited cell to render the source beside the claim.
  4. 4.POST/v1/api/agent-runsAPI keyFor a conversation rather than one read: open a run.
  5. 5.POST/v1/api/agent-runs/{runId}/messagesAPI keyAsk; the run decomposes an open-ended goal into steps.
  6. 6.POST/v1/api/agent-runs/{runId}/stream-ticketAPI keyMint the ticket a browser needs to read the stream without holding the key.
  7. 7.GET/v1/api/agent-runs/{runId}/streamAPI keyStream the answer as it lands, citations included.

YieldsEvery claim with the ids behind it, so your product can render a receipt rather than a paragraph.

03

Change without re-reading

What the watcher does: a file that changes re-reads only its delta, and the answer changes with it.

  1. 1.PUT/v1/projects/{projectId}/files/{fileId}/contentAPI keyReplace one file’s content; only the delta re-ingests.
  2. 2.POST/v1/projects/{projectId}/files/reingestAPI keyRe-read a set of files on purpose: a schema moved, a parser improved.
  3. 3.POST/v1/api/projects/{projectId}/files/stream-ticketAPI keyMint a ticket so a page can subscribe to file changes without the key.
  4. 4.GET/v1/projects/{projectId}/files/streamSessionSubscribe: per-file status as it moves, the same feed the app’s progress bars read.

YieldsA project that stays current under your customer’s edits, with progress you can show.

04

Deliver a cited artifact

The page Ro drafts with a citation on every line, produced for your own surface.

  1. 1.POST/v1/api/actionsAPI keyGenerate an artifact from a brief; provenance rides every claim.
  2. 2.GET/v1/projects/{projectId}/files/{fileId}/entitiesAPI keyRead what a source resolved to: the people, terms and components a claim names.
  3. 3.PATCH/v1/projects/{projectId}/files/{fileId}API keyPromote the artifact to a file the project cites from now on, or demote it.

YieldsA deliverable whose every line opens the source it came from.

05

Provision a customer

Runlog under your brand: one project per customer, one narrow key per service, nothing shared between them.

  1. 1.POST/v1/projectsAPI keyCreate the project, the memory boundary every later call is scoped to.
  2. 2.POST/v1/mcp-keysAPI keyMint a project-bound key for the service that will read and write it.
  3. 3.POST/v1/projects/{projectId}/files/zipAPI keyBring the first corpus in as a zip; a codebase or a folder of documents alike.
  4. 4.GET/v1/projects/{projectId}/filesAPI keyConfirm what landed and watch it move to done.
  5. 5.POST/v1/api/actionsAPI keyThe first cited answer, from your product, on your customer’s data.

YieldsAn isolated memory per customer that your product reads through one key; the white-label model’s unit of work.