Skip to content
Docs menu

Console home, Get started and onboarding paths

Read the console's Overview, finish the first-run checklist on Get started, build onboarding paths for new members, look up a guardrail code and ask your organisation's knowledge.

View .md

The pages a member sees first: the Overview after every sign-in, Get started for a new organisation, the onboarding paths for new teammates, the page every guardrail code links to, and Ask.

Overview

/dashboard is the Admin app's first page (sign-in lands on Home; the operator without an org seat still lands here). Any signed-in person can open it; it shows only the cards your role may read.

Card What it shows Click goes to
Requests, last hour requests through this cloud's /v1 and what they cost Requests, query since:1h
Errors, last hour failed requests and their share Requests, query is:error since:1h
p95 latency 95th percentile latency Requests, since:1h | p95(latency), p50(ttft) by model
Active daemons daemons serving now, out of all enrolled Daemons
Suspect / offline daemons that stopped answering, and how many are draining Daemons
Models served now distinct models the active daemons serve Requests, since:1h | count by model
Online now people active in the last 5 minutes Activity
Jobs, last hour relayed jobs and how many failed Jobs

Request cards need the logs permission (logs:read); a role without daemons and jobs access (billing) sees a list of the pages it can open instead. "Connect a daemon" (/daemons/new) shows for roles that may enroll daemons. Each number links to the query behind it, so a spike is one click from the requests that make it.

While the organisation is new, the first-run checklist is at the top. "Hide" hides it from the Overview (a cookie); it stays on Get started.

Get started

/get-started is the first-run path after sign-up. The top bar's "Setup 3/6" and the command menu (⌘K) open it. It needs keys:read. The public version of the same steps is the Venom Cloud quickstart.

The checklist

Each step ticks itself from what exists; there is nothing to mark by hand. Buttons show only when your role may use them.

Step Done when Buttons
Connect a model source the organisation has a provider key or a daemon Add a provider key (/providers/new), Connect a daemon (/daemons/new)
Pick a gear the organisation defined a gear Create a gear (/gears)
Install the CLI and log in a venom cloud login minted a key, or a key people use sent a request the install and venom cloud login lines; Use an API key instead
Send a test request any request went through, this test included Send: one request of at most 64 tokens through your routing, with the answer and its cost
Invite a teammate the organisation has a second member, or an invitation was sent Invite (/settings/members?invite=1)
Set a budget a spend budget or a monthly spend cap exists New budget (/budgets)

The checklist shows on the Overview for the first 30 days, or until the organisation sends its first request, and disappears once every step is done. Under it, "Hide it there" and "Show it there" toggle the Overview card. A legacy key group session has no "Invite a teammate" step.

The test request is also POST /api/admin/v1/setup/test (keys:write), body {model?, tenant_id?}: one tiny chat completion through the organisation's routing, answered with the reply, who served it and what it cost. 409 no_model_source when nothing serves a model yet (nothing is sent), 400 model_not_served for a model nothing serves now, 429 too_soon within a few seconds of the last test.

Or use an API key

For CI, a server or an OpenAI SDK: pick a key group, name the key (who or what uses it, such as alice-laptop) and create it. The key (vck_…) is shown once, with a block that installs venom, sets VENOM_BASE_URL and VENOM_API_KEY and tests the setup:

export VENOM_BASE_URL=https://cloud.usevenom.dev/v1
export VENOM_API_KEY=vck_…
venom doctor

Creating a key needs keys:write (owner, admin or developer). All key options are on API keys.

Onboarding paths

/onboarding-paths (the nav's "Onboarding") holds guided first tasks for new members on your own repositories: read the tour, run the tests, fix a small issue, ship a pull request. A member sees their checklist there and walks it in the terminal with venom onboard, which starts each step. Steps tick themselves when the work shows up.

Who Can
org:manage (owner, admin) create a path from scratch or from a starter ("Ship your first change", "Get oriented"), edit, reorder and remove steps, delete paths, see every member's progress
routing:read (every role but billing) see their own checklist, tick a manual step

At most 20 paths of 20 steps each. Removing a step drops its progress.

Step kind What venom onboard next does
tour runs venom tour, done when it finishes
template starts a session from a template, with arguments
task starts a session whose first message is the step's prompt
issue, pr says what to do
Signal Done when
manual the member says so: the button on the page, or venom onboard done <step>
session one of their sessions ended
edit such a session changed files
pr_merged, issue_closed their venom reported a merged pull request or a closed issue; needs tasks.lookup: gh in their venom.yaml

Signals count only work done through the member's own keys (keys their venom cloud login made), after the later of the path's creation and the member's joining. The operator picks an organisation in the org switcher first. More on the command in venom onboard.

Guardrail codes: /g/{code}

Every request a guardrail blocks answers 403 guardrail_blocked with a code such as GR-ORG-CRED-001, and the x-venom-guardrail header links to /g/{code}. Any member of the organisation (org:read) can open it. It shows:

  • what the rule checks (the kind of thing, never its word lists or patterns);
  • what it does (block, deny, keep local, downgrade, ask, redact, rewrite or warn), whether it is switched off, and whether it is in monitor mode, only recording what it would have done;
  • who set it: the organisation, a key group or a member, and what lower layers may do: Locked (nothing), Tighten only (make it stricter) or Members may turn off (audited);
  • how to get an exception: whom to ask and their contacts. Mention the request id the error named.

Codes have the form GR-ORG-…, GR-TEAM-… or GR-ME-… followed by a 2 to 6 letter kind and a 3 to 6 digit number. Anything else shows "Not a guardrail code". A member's own rule is visible in full only to them; everyone else sees "a personal guardrail". "Requests it fired on" opens Requests with guardrail:<code> last:7d. Writing guardrails is covered on the Guardrails page of this section (see the section overview).

Ask

/ask answers a question about how your team works from what the organisation already knows: org memory, the team library and session summaries, each read with your own permissions, with the sources linked. It needs routing:read. Questions are cut at 1,000 characters. The same answers come from venom ask in a terminal (which adds the docs of your checkout; see venom ask) and from /venom ask in Slack.

Troubleshooting

Symptom Cause and fix
Overview shows "?" with "logs unavailable" The log engine could not answer. Reload; check Requests.
Overview shows only "Your pages" Your role reads neither daemons nor jobs (billing). Expected.
A checklist step stays open It reads what exists: a key that only the checklist's own test used does not tick "Install the CLI".
Onboarding and Ask say "Choose an organisation" You are the operator: pick an organisation in the org switcher.
"Your role cannot change onboarding paths (org:manage)." Only owners and admins build paths.
"Unknown guardrail" on /g/{code} Your organisation has no rule with that code: it was removed, or the link came from another organisation.