Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Conversation API is the control-plane surface for chat history and agent execution state. It stores conversation data in Postgres, coordinates live agent output, and keeps a durable event log for replay and recovery.

Docs map

Concepts

PageUse it to understand
Architecture and flowHow a message moves through Studio, API, agents, streams, and durable state
Durable executionHow messages, agent runs, workflow runs, job runs, tasks, and cron jobs relate
Events and streamingHow SSE AG-UI transport maps to persisted run events and WebSocket notifications
Datastores and lineageHow Postgres, Redis, IDs, parent links, and cursors fit together

Reference

PageUse it to find
Endpoints and validationREST operations, SSE stream routes, WebSocket notification routes, AG-UI routes, durable run routes, control-plane routes, and schema contracts
AuthorizationBearer token, project access, conversation access, and JWS boundaries
Connect an agentThe runtime contract for developer-provided agents

Key concepts

  • Conversation: The durable thread that owns messages, participants, read state, and conversation-owned runs.
  • Message: A user, assistant, or tool entry made from typed content parts.
  • Run: A canonical durable execution record with a public run ID, kind, owner, status, parent run, and root run.
  • Agent run: A conversation-owned run with kind: "agent". It represents chat or project-agent execution attached to a conversation.
  • Workflow run: A project-owned run with kind: "workflow". It represents a workflow target and its step graph.
  • Job run: A project-owned run with kind: "job". It represents background execution of a target, including task targets.
  • Task: A developer-defined unit of background work. Jobs execute tasks when the job target points at a task.
  • Cron job: A schedule definition. Each scheduled or manual trigger creates a job run.
  • Run event: An ordered event attached to a run. Events power snapshots, replay, and public SSE streams.
  • SSE stream: The response transport that updates Studio while a run is active.
  • WebSocket notification: A lightweight event that tells Studio to invalidate and refetch state. It does not carry the token stream.