Documentation Index
Fetch the complete documentation index at: https://docs.crewship.ai/llms.txt
Use this file to discover all available pages before exploring further.
Chat & Sessions
Overview
Chatting with an agent is a first-class surface in Crewship. PRs #213, #214, #223, and #225 re-shaped it from a side drawer into a full-page experience with session history, attachments, message reactions, and a right-panel that exposes the agent’s working files, artefacts, and a live terminal. The split-screen layout from PR #314 finished the job — chat on the left, the agent’s workspace surfaces on the right, both live and both deep-linkable.
A “session” in Crewship is intentionally durable. It’s a chats row scoped to one agent, with a stable ID that survives page reloads, browser restarts, and operator hand-off — anyone with read access to the agent can resume the same conversation history. The schema has grown alongside the UI: PR #225 added chat_branches (edit-and-resend trees), message_reactions, chat_attachments, and workspace_files, plus chats.origin (migration v59) for grouping in the Sessions sidebar by where the conversation started — one of UI / CLI / WEBHOOK / CRON / AGENT, written by POST /api/v1/agents/{agentId}/chats. The point of the breadth: a chat is more than text — it’s a typed transcript backed by structured tables so search, audit, and replay all work the same way no matter which surface produced the message.
This guide covers the model, the URL state, and the surfaces a power user (or integrator) cares about. The component reference lives in the frontend codebase (app/(chat)/chat/) and the persistence layer lives in internal/api/chat.go + the Go migrations under internal/database/migrate.go; here we focus on what the platform persists and how the URL state composes with it.
When to use it
Most chat surface usage is self-evident — “talk to the agent” — but the durable-session design unlocks several flows worth reaching for explicitly:
- Resume a multi-day conversation. A session ID survives reloads and operator hand-off, so
/chat/<agent>?session=<chatId> is the canonical “where we left off” URL. Bookmark it, paste it into Linear, share it on Slack — the recipient lands on the same transcript, the same right-panel state, and (with &panel=files) the same artefact tab.
- Reroll a bad agent response without abandoning context. Hover-edit the user message and the conversation truncates from that point; the new edit sends as a fresh turn. The transcript before the edit is preserved as a chat branch so the alternate timeline isn’t lost — useful when you discover the original direction was right after all.
- Triage what an agent has been doing. The Sessions sidebar groups by
chats.origin (UI / CLI / WEBHOOK / CRON / AGENT) so you can see at a glance which conversations were started by the user vs by automation vs by a peer agent. Filter the sidebar to WEBHOOK-origin sessions if you want to audit what an integration has been driving through your agents.
- Watch an agent work in real time without opening the journal. The right-panel Files, Artifacts, Terminal, and Diff tabs stream the live state of the agent’s container while the chat is open. Faster than tailing logs, and the URL deep-links to a specific tab via
&panel=files / &panel=terminal.
- Programmatic chat creation from CLI / webhook / cron.
POST /api/v1/agents/{agentId}/chats accepts an origin enum on the body and renders a coloured chip in the UI sidebar. Use CLI for crewship run-style invocations, WEBHOOK for trigger-handlers, CRON for scheduled routines, AGENT for peer-to-peer assignments — the chip helps a human operator scrolling the sidebar understand provenance at a glance.
For one-off “ask the agent a question” use, just open /chat/<agent> and start typing — the session row gets created automatically on first send.
Key concepts
| Term | What it means here |
|---|
| Session | One row in chats, scoped to one agent. Stable ID, persists across reloads and operators. Anyone with read access to the agent can resume the same transcript. Created lazily on first send (or explicitly via POST /api/v1/agents/{agentId}/chats). |
chats.origin | A NULL-able enum stamped at create time: UI, CLI, WEBHOOK, CRON, or AGENT. Anything else is stored as NULL so a rogue caller cannot inject arbitrary text into a UI chip. Migration v59. |
| Chat branch | A divergence in the conversation tree produced by edit-and-resend. The truncated tail isn’t deleted — it lives in chat_branches (migration v57) so the alternate timeline stays retrievable. The active branch is the one currently rendered. |
| Slash palette | Server-registered command set surfaced by typing / at start-of-line or Ctrl+K anywhere. Commands like /eval, /checkpoint, /skill are parsed as structured commands (not chat messages) and route to dedicated handlers. |
| Model picker | Per-turn override of the agent’s llm_model. Lives next to the send button. The override applies only to the current send — the agent’s default model is unchanged for subsequent turns. |
| Attachment | A file uploaded into a chat — image, document, log, anything ≤25 MB. Stored on the server’s storage provider with a chat_attachments row pointing at it (migration v57). The agent’s container sees the file under /output/<agentSlug>/attachments/<chatId>/<filename>. |
| Reaction | A workspace-shared emoji vote on a single assistant message. Persisted in message_reactions (migration v57) with UNIQUE(chat, message, emoji, user) so POST is idempotent. Aggregated counts ({emoji, count, mine}) returned by List. |
| Right-panel tab | One of Files (F1), Artifacts (F2), Diff (F3), or Terminal (F4). Each tab streams independently; switching tabs doesn’t retrigger inactive streams. URL state &panel=… deep-links to a tab. |
| Shallow router state | Browser-only URL params written via window.history.replaceState (helper: useShallowSearchParam). Used for which panel is open, which message is being edited, slash-palette state — none of which justify a full Next.js navigation but all of which should appear in copy-pasted URLs. |
request_id | A client-generated UUID stamped on every send. The server idempotently dedupes by request_id so a retry after a WS reconnect never duplicates the user turn. Surfaced on outbound messages so clients can correlate sent-vs-acknowledged. |
| Presence chip | The small status indicator in the composer footer — online / thinking / blocked / offline. Driven by the Watch Roster; not a guess from idle timers. |
| Pinned session | A session with a per-user pin flag set. Pinned sessions float to the top of the sidebar regardless of last-message timestamp. Useful for “the conversation I always come back to”. |
workspace_files | The durable, workspace-scoped blob index (migration v57). The Files right-panel reads from this view; mid-edit files live there until the agent’s next commit. |
Usage
The end-to-end loop from “I have an agent” to “we had a productive conversation about it” is five steps. Each step has a dedicated section below with the full surface area; this is the orientation walk-through.
1. Open the chat
https://crewship.example.com/chat/viktor
Drops you into Viktor’s most recent session. To start fresh, click New session in the sidebar. To jump to a specific past conversation, paste the deep-link URL ?session=<chatId>. To approach from the canvas instead, use /crews?crew=<slug>&agent=viktor — see Routes.
2. Send a message
Type into the composer and hit Enter. The agent’s response streams back via WebSocket; the presence chip in the footer shows thinking while the model is generating. Useful composer tricks (full detail in Composer):
/ to open the slash palette for structured commands (/eval, /checkpoint, /skill <name>).
- Drag, paste, or click-upload an image / file — capped at 25 MB, surfaced to the agent under
/output/<agentSlug>/attachments/….
- Pick a different model from the dropdown next to Send for this turn only (handy for switching to Opus mid-conversation for a hard step).
3. Watch the agent work
While the agent is acting, flip the right panel to the relevant tab — see Right panel for the full tab map:
- F1 / Files — live working tree under
/workspace.
- F2 / Artifacts — generated reports, screenshots, downloads.
- F3 / Diff — live diff vs. the workspace’s last commit, while the agent is mid-edit.
- F4 / Terminal — read-only tmux attach (OWNER/ADMIN can flip to read-write).
Each tab is its own URL query param (&panel=files, etc.), so you can share the exact view you’re staring at.
4. React or reroll
Hover an assistant message to surface the reactions strip (👍 👎 ❤️ 🤔 🚀). Reactions are workspace-shared and surface back to the agent on the next turn so it can adjust. Hover a user message instead to surface Edit — editing rewrites that turn and truncates the conversation, but the old branch lives on in chat_branches and can be revisited later via the branch picker. See Edit-and-resend.
5. Resume later
Just copy the URL. The session ID is in ?session=<chatId>, the right-panel state is in &panel=…. Bookmark, paste into Linear, share over Slack — anyone with read access on the agent lands on exactly the same view (their reactions are scoped to them, the session itself is shared). Pin the session in the sidebar if it’s a long-running thread you want to surface above the timestamp-sorted list.
For non-UI surfaces — CLI-initiated chats, webhook-driven chats, scheduled chats — see the API reference below; the origin field on the create payload stamps the right sidebar chip so an operator scrolling the list can tell at a glance which conversations came from automation.
Examples
Pair-debugging a failing test
A test is red in CI and you want the agent’s eyes on it. Open the agent and start a new session:
https://crewship.example.com/chat/viktor
Drag the failing test’s snapshot file into the composer — it lands at /output/viktor/attachments/<chatId>/snapshot.txt inside the container; the agent opens it via the Files tab (F1). As the agent edits the test, flip to Diff (F3) to watch the patch take shape against HEAD; when it wants to run the suite, switch to Terminal (F4) and watch the output stream live. Each tab is its own URL param (&panel=files / &panel=diff / &panel=terminal), so the link you share with a teammate drops them onto the exact view you’re looking at.
When the suite goes green, 👍 the assistant’s final message — the reaction surfaces back to the agent on the next turn as positive signal and shows up in Quartermaster replays as coarse human feedback.
Webhook-driven issue triage
A GitHub issue webhook fires; your trigger handler posts to Crewship:
curl -X POST https://crewship.example.com/api/v1/agents/triage-bot/chats \
-H "Authorization: Bearer $CREWSHIP_PAT" \
-d '{
"origin": "WEBHOOK",
"initial_message": "Triage GH issue #482: Login broken on mobile Safari. Repro steps inside.",
"metadata": {"github_issue": 482, "repo": "acme/web"}
}'
# {"chat_id":"cht_xyz789","origin":"WEBHOOK","created_at":"…"}
The new session shows up in the agent’s sidebar with a coloured WEBHOOK chip, so an operator scrolling the list can distinguish auto-triaged issues from human-initiated conversations at a glance. The agent processes the message, does its triage, posts a summary — and a human can take over the conversation by opening ?session=cht_xyz789 and replying directly.
Cross-operator escalation
You’re chatting with viktor about a production outage and realise this needs an SRE’s eyes. Pin the session in the sidebar so you can come back to it, copy the URL with the right panel set to Terminal:
/chat/viktor?session=cht_abc123&panel=terminal
Paste into the SRE channel on Slack with one line: “Live terminal on the agent’s repro — viktor’s pinned this for me.” The SRE clicks, lands on the same chat session with the same active right-panel tab (terminal) and the same live exec stream — though their own reactions are scoped to them. They reply in the chat; their messages join the same transcript, visible to both of you and to anyone else who opens the URL.
When the incident closes, the session row survives — it stays as a permanent record of what was said, what was tried, and what fixed it. The webhook-triggered originals from step 2 and the human-driven escalation here live in the same chats table, distinguishable only by their origin chip in the sidebar.
API reference
The chat surface is small — no dedicated /api-reference/chats page yet; the handler source is internal/api/chat.go. Every endpoint requires Authorization: Bearer <CLI token> or a valid session cookie, and access is gated by the caller’s read/write role on the parent agent.
Sessions (chats)
| Method | Path | Purpose |
|---|
POST | /api/v1/agents/{agentId}/chats | Create a session. Body: {initial_message?, origin?, metadata?}. origin is one of UI / CLI / WEBHOOK / CRON / AGENT — anything else is stored as NULL. |
GET | /api/v1/agents/{agentId}/chats | List the agent’s sessions. Query: origin=…, pinned=true, archived=true, limit (default 50). |
GET | /api/v1/chats/{chatId} | Full session detail including the message stream. |
PATCH | /api/v1/chats/{chatId} | Rename / pin / archive. Body: {title?, pinned?, archived?}. |
DELETE | /api/v1/chats/{chatId} | Delete a session. Cascade-deletes messages, reactions, attachments, branches. |
Messages
| Method | Path | Purpose |
|---|
POST | /api/v1/chats/{chatId}/messages | Send a user turn. Body: {content, request_id, model?, attachments?}. Idempotent under request_id. |
GET | /api/v1/chats/{chatId}/messages | Paginated message history. Keyset cursor; newest-first. |
PATCH | /api/v1/chats/{chatId}/messages/{messageId} | Edit a user turn. Truncates the active branch; the old tail moves to chat_branches. |
Reactions
| Method | Path | Purpose |
|---|
GET | /api/v1/chats/{chatId}/messages/{messageId}/reactions | Aggregated counts: [{emoji, count, mine}]. |
POST | /api/v1/chats/{chatId}/messages/{messageId}/reactions | Body: {emoji}. Idempotent under UNIQUE(chat, message, emoji, user). |
DELETE | /api/v1/chats/{chatId}/messages/{messageId}/reactions/{emoji} | Emoji is a path segment. |
Attachments
| Method | Path | Purpose |
|---|
POST | /api/v1/agents/{agentId}/chats/{chatId}/attachments | Upload a file (multipart, ≤25 MB). Returns the file’s storage URL + the chat_attachments row ID. Handler: ProxyHandler.AgentChatAttachment in internal/api/proxy_attachments.go. |
GET | /api/v1/chats/{chatId}/attachments | List attachments on a chat. |
DELETE | /api/v1/chats/{chatId}/attachments/{attachmentId} | Remove an attachment. The blob is also evicted from workspace_files. |
Realtime (WebSocket)
The chat page subscribes to the per-session WebSocket channel (session:<chatID>) and listens for the events the runtime actually emits. There are no chat.message.* or chat.reaction.* events today — message turns are read back via REST after a successful POST, and reactions are local-state-only on the client.
| Event | Channel | When it fires |
|---|
assignment_created | session:<chatID> | The agent kicks off a new assignment from a user turn. |
assignment_running | session:<chatID> | The assignment transitions into execution. |
assignment_completed / assignment_failed | session:<chatID> | Terminal state — the agent’s reply (or the failure) is ready to fetch. |
peer_query_running | session:<chatID> | A peer-query sub-task started inside this chat (multi-agent dispatch). |
escalation_created / escalation_resolved | session:<chatID> | The agent escalated to a human, or the escalation was decided. |
port_expose_created | session:<chatID> | The agent opened a container port and the proxy URL is ready. |
Each event triggers a REST re-fetch of the affected resource — the server-side state is authoritative and the next render is a function of that, not of imperative local mutations. Reconnect is idempotent: sends in-flight at disconnect time carry the same client request_id and the server dedupes.
Routes
Two top-level routes serve chat:
| Route | Purpose |
|---|
/crews?crew=<slug>&agent=<slug> | Selection-driven canvas. Click an agent in the canvas to open a chat panel inline. |
/chat/<agentSlug>?session=<chatId> | Full-page chat — the same agent, the same session model, the whole viewport for messages + composer + right panel. |
The /chat/<agentSlug> URL is deep-linkable — the session query parameter scopes to a specific chat history. Without ?session, the route opens the agent’s most recent chat. With a session ID, it scrolls to that chat’s history and resumes the conversation in place.
The state of which tab is open in the right panel, which message is being edited, whether the slash palette is open, and the like is held in shallow router state — useShallowSearchParam writes to window.history.replaceState directly without triggering a Next.js navigation. This keeps the page interactive (no rerender on tab switch) while still giving you a copyable URL for any state.
Sessions
A “session” is a chats row. Sessions persist across page reloads, browser sessions, and operators (any user with read access to the agent can see its history). Migration v59 added the chats.origin column (DB-side; the Prisma TypeScript schema is intentionally not regenerated for this column — Prisma is types-only in this project). The Go handler at POST /api/v1/agents/{agentId}/chats accepts an origin field on the body and whitelists these values:
origin value | When written |
|---|
UI | Created via the chat page in the browser. |
CLI | Created via crewship run or other programmatic CLI use. |
WEBHOOK | Created by a webhook trigger (see Webhooks). |
CRON | Created by a scheduled trigger. |
AGENT | Created by a peer agent (agent-to-agent assignment). |
Anything else (or empty) is stored as NULL so a rogue caller cannot shove arbitrary text into a UI-rendered chip. The Sessions sidebar renders a colored chip per origin — NULL rows show no chip. Sessions can be renamed, archived, or pinned; pinning floats a session to the top of the sidebar regardless of last-message timestamp.
Composer
The bottom-of-page composer is a single textarea with three superpowers:
- Slash palette — typing
/ at the start of a line opens a fuzzy-search palette over registered slash commands (e.g. /eval, /checkpoint, /skill <name>). Commands are registered server-side so a multi-line /eval my-suite --baseline last-week is parsed as a structured command rather than a chat message.
- Model picker — dropdown next to the send button overrides the agent’s default
llm_model for this turn only. Useful when an operator wants to spend Opus on a hard reasoning step inside an agent that normally runs Sonnet.
- Attachments — paste images, drag files, or paste image data from the clipboard. Files are uploaded via
POST /api/v1/agents/{agentId}/chats/{chatId}/attachments (handler ProxyHandler.AgentChatAttachment in internal/api/proxy_attachments.go) and stored on the server’s storage provider with a chat_attachments row pointing at them (migration v57). The agent’s container sees the file under /output/<agentSlug>/attachments/<chatId>/<filename>. 25 MB cap per upload.
Enter sends; Shift-Enter inserts a newline. Ctrl+K opens the palette unconditionally.
Edit-and-resend
Hovering over a user message reveals an “Edit” button. Editing the message rewrites that turn and truncates the conversation — every message after it is dropped. The new edit is sent as a fresh user turn. This matches the ChatGPT/Claude UX and lets operators reroll an agent’s response without abandoning the whole session.
Message reactions
Each assistant message has a reactions strip (👍 👎 ❤️ 🤔 🚀). Reactions are workspace-shared — if two operators are in the same workspace, they each see the other’s reactions. Migration v57 added the message_reactions table.
| Method | Path | Purpose |
|---|
GET | /api/v1/chats/{chatId}/messages/{messageId}/reactions | Aggregated counts: [{emoji, count, mine}]. |
POST | /api/v1/chats/{chatId}/messages/{messageId}/reactions | Body: {emoji}. Idempotent under UNIQUE(chat, message, emoji, user). |
DELETE | /api/v1/chats/{chatId}/messages/{messageId}/reactions/{emoji} | Emoji is a path segment. |
The List response is aggregated (one row per emoji, with count and mine boolean) — not a per-user list. This keeps the FE’s 👍 3 (you) rendering a single fetch.
Reactions are surfaced to the agent on the next turn as part of the conversation context: the model sees that a previous response was 👎‘d by an operator and can adjust. They are also surfaced in Quartermaster replays as a coarse human-feedback signal.
Right panel
The right side of the chat surface is a tab strip. Tabs are sticky — switching agents preserves which tab was open, but switching tabs does not retrigger the SSE/WS streams from the inactive tabs.
| Tab | Hotkey | Purpose |
|---|
| Files | F1 | Live view of the agent’s working tree under /workspace. Click a path to preview; double-click to open in the in-page editor. |
| Artifacts | F2 | Generated outputs — markdown reports, screenshots, downloads. Pulled from output/ mount. |
| Terminal | F4 | Live tmux attach to the agent’s session via the sidecar’s interactive exec endpoint. Read-only by default; OWNER/ADMIN can flip to read-write. |
| Diff | F3 | (When the agent is mid-edit) live diff against the workspace’s last commit. |
The terminal tab reads from the sidecar’s exec stream and writes back through the same socket; latency is bounded by the WS round-trip. Closing the tab does not kill the agent’s tmux session — re-opening reattaches.
Presence and reconnect
The composer footer shows a small presence chip — “online”, “thinking”, “blocked”, or “offline” — driven by the Watch Roster. When the WS connection drops, a reconnect banner appears at the top of the chat (“Reconnecting…”), the composer disables sends, and queued user messages are flushed once the socket re-establishes.
Network blips do not lose messages. Sends that were in-flight at disconnect time are retried with the same client-generated request_id; the server idempotently dedupes by request_id so a retry never duplicates a turn.
URL state cheat-sheet
| URL fragment | Meaning |
|---|
/chat/viktor | Most recent session for viktor. |
/chat/viktor?session=cht_a1b2c3 | Specific session; deep-linkable. |
/chat/viktor?session=cht_a1b2c3&panel=files | Open the Files tab on load. |
/chat/viktor?session=cht_a1b2c3&panel=terminal | Open the Terminal tab on load. |
/crews?crew=backend&agent=viktor | Canvas view, viktor selected. |
These query params are stable. Do not link to the Next.js internal route segments; those are subject to refactoring.
Common pitfalls
- Edit-and-resend truncates the active branch — but the tail isn’t gone. Editing a user message moves every message after it into
chat_branches. The UI shows a small “view earlier branches” affordance, but a hurried operator may believe they’ve lost the alternate response. Train the muscle of opening the branch picker before assuming work is unrecoverable.
- Reactions are workspace-shared, not per-user-private. A 👎 from one operator is visible to every other operator in the same workspace, and is also surfaced to the agent on the next turn. Use reactions as a deliberate signal — not as a private bookmark. If you need a private flag, use the Inbox pin instead.
chats.origin silently NULLs unrecognised values. Anything outside the UI / CLI / WEBHOOK / CRON / AGENT allow-list gets stored as NULL to keep the UI chip safe from injection. A webhook handler that posts origin: "github" will succeed (200 OK) but show no chip — the silent failure is by design. Validate the enum on your side before posting.
- Prisma TypeScript schema is intentionally stale on
chats.origin. Prisma is types-only in this project; the v59 migration was applied to SQLite but the prisma/schema.prisma was deliberately not regenerated. TS callers must query origin via the Go-typed API surface, not via Prisma Client.
- Attachment cap is 25 MB, with different error surfaces by client. Uploads larger than 25 MB return a 413 from
ProxyHandler.AgentChatAttachment. The browser composer surfaces this as a toast, while a programmatic uploader (CLI, webhook) sees only the HTTP error — check status codes before assuming the file landed.
- The Files right-panel shows mid-edit state, not committed state. It reads
workspace_files, which tracks the agent’s live working tree. If you want to see what was actually committed by the agent, look at the Diff tab against HEAD, or run git log in the Terminal tab — the Files view is intentionally optimistic.
- Closing the Terminal tab does NOT kill the agent’s tmux session. Re-opening reattaches to the same shell. This is a feature (long-running commands survive a tab close) but operators sometimes assume “close” means “stop”. To actually stop, kill the process inside the terminal first.
request_id must be stable per logical send, not per React render. Generate the UUID once when the user hits Send, not in the render function. A re-render-derived ID lets the server treat a retry as a new turn — defeating the dedupe contract.
- Slash palette commands must be registered server-side.
/foo in the composer where foo isn’t a registered command sends the literal text as a chat message — there’s no client-side “unknown command” error. Add commands via the slash-command registration interface in internal/api/chat.go rather than expecting the UI to discover them.
- Shallow router state evaporates on hard navigation.
panel=files survives in-app tab switches and back/forward, but a hard reload that hits a 3xx redirect (e.g. auth expiry → login → bounce) loses everything past ?session=…. Bookmark with intent, not panic.
- WS reconnect dedupes by
request_id, not by content. Two genuinely different sends that collide on a re-used request_id will silently merge into one turn server-side. Use a fresh UUID per logical send.
- Right-panel tabs don’t unsubscribe on inactive. Switching from Terminal to Files stops the render of the terminal stream but the WS subscription stays live in the background. This is intentional (re-opening the tab is instant) but means a workspace with many open chat tabs holds many parallel sidecar exec streams — heavy for the sidecar.
- Activity — the live canvas where the same agent’s mission runs show up; the chat is one operator surface, Activity is the other.
- Watch Roster — the source of truth for the composer presence chip (
online / thinking / blocked / offline).
- Quartermaster — replays consume message reactions as a coarse human-feedback signal (👍 / 👎 surfaces back to evals).
- Skills — slash-palette commands like
/skill <name> route into the skills registry rather than being treated as chat messages.
- Hooks — server-side handlers that fire on
chat.message.created / chat.reaction.added and can drive automation off chat events.
- Files and output — the
workspace_files blob index that the Files right-panel reads from; same view the agent’s container sees.
- Keeper — credential injection for tools the agent invokes from inside a chat; keeps secrets out of message bodies.
- User preferences API — composer settings (default model, slash-palette behaviour).
- Conversations API — message reactions, attachments, crew messaging.
- Webhooks — programmatic chat-session creation (
origin=WEBHOOK).