Skip to content
HTTP route reference

HTTP route reference

Every HTTP route the Runink TIDE console registers. All routes are served by the TIDE operator process on the console’s own origin. There is no separate API host and no bearer-token API for browsers: the web app authenticates with the session cookie.

The per-category references give the request and response detail and the exact authorisation of each route:

How routes are authorised

ClassRuleExamples
Openno session needed/healthz, /api/me, /api/plans
Session reada GET needs a signed-in session when sign-in is configured (requireSession); on an open console it is served/api/dashboard, /api/namespaces, /api/gitops
Privileged writea session and the adminRefusal predicate against an allowlist env var; audited on success, failure and refusalPUT /api/agent-schedules/{name} (CONSOLE_AGENT_ADMINS), POST /api/connections (TIDE_CONNECTION_ADMINS)
Machine ingesta shared token generated once in tide-system; unset means the door refuses everythingPOST /api/agent-health (TIDE_HEALTH_INGEST_TOKEN), POST /api/rules-recon/report (TIDE_RECON_INGEST_TOKEN), POST /api/judgement/submissions (TIDE_JUDGEMENT_INGEST_TOKEN)
Agent reporta GitHub App installation token for the console’s org (authorizeReporter)POST /api/session-runs, POST /api/data-governance-findings, POST /api/judgements, POST /api/playbook-runs/step-report

An allowlist that is unset means “every identity this console admits”. That is not a wildcard, because sign-in itself fails closed. CONSOLE_SESSION_ADMINS is the exception: unset means nobody. GET /api/access lists every allowlist. See Agents › Access.

Reads that could not reach their source still answer 200, with source: "unavailable" and complete: false in the body. See Status and provenance.

Sign-in and sessions

RouteMethodsPurpose
/healthzGETliveness: answers ok
/auth/callbackPOSTGoogle Identity Services credential, with the double-submit g_csrf_token
/auth/googlePOSTthe Flutter app’s Google token exchange (JSON)
/auth/passwordPOSTusername and password sign-in, when CONSOLE_ADMIN_PASSWORD is set
/auth/logoutanyrevokes the server-side session
/api/meGETsign-in state and client config: authed, email, authRequired, passwordAuth, googleAuth, googleClientId, recaptchaSiteKey, voiceTts, voiceStt
/api/sessions/revoke-allPOSTend every session of a subject
/api/session-adminsGET, PUTwho may read the audit trail and end other people’s sessions

Audit and access

RouteMethodsPurpose
/api/auditGETnewest-first page of the audit chain and its verdict
/api/audit/{seq}GETone record in full, with its neighbours’ hashes
/api/audit/verifyGETwalk the persisted chain and name the first break
/api/accessGETwhich allowlists are live, their sizes, and your own membership only

Reading the audit trail requires a session admin (CONSOLE_SESSION_ADMINS).

Chat and voice

RouteMethodsPurpose
/chatPOSTthe orchestration chat: one tool call per message; mutating calls need confirm <code>
/api/ttsPOSTsovereign text-to-speech through TTSD_URL
/api/sttPOSTsovereign speech-to-text through VOICE_REMOTE_URL

Platform and cluster (DevEx)

RouteMethodsPurpose
/api/dashboardGETtracked workloads and client instances
/api/control-planesGETFACE and PULSE control-plane CRDs
/api/cluster-nodesGETKubernetes Nodes and dedicated-taint isolation
/api/namespacesGETper-namespace workloads, pods, events, quotas and a verdict
/api/nodes/{name}GETone node: conditions, capacity, taints, pods by namespace
/api/servicesGETserving status: ready/desired, and whether a readiness probe backs it
/api/routesGETedge routes and /forge/, traced to Service, endpoints and workload
/api/app-consolesGETDevEx › Application consoles: one card per tool the viewer may reach
/api/instances/overviewGETthe Overview’s bird’s-eye: every instance and control plane the viewer may see
/api/instances/openGETan instance card’s Open: a member-only entry ticket to that instance
/api/ci-runnersGETAgent runs › CI runners
/api/agent-modelsGETeach agent’s model chain, resolved from what it sends: token, router tier, backend, adapter, card, server
/api/hunter-runsGET, POSTthe backlog hunter’s runs (session read; the POST is the hunter’s token-authenticated ingest)
/api/knowledge/searchGETBusiness rules › Knowledge: search an instance’s corpus
/api/knowledge/upload, /api/knowledge/ingestPOSTadd uploaded files, or a document connection’s text, to an instance’s corpus (admins)
/api/gitopsGETClusters › GitOps: per workload, the desired version from the tide-cd.yml lineage record against what is running, and the drift
/api/lineageGETper image: merged → agents → built → registry → rolled → running; ?sha= answers “did my commit ship”
/api/doctorGETthe ops doctor CronJob: state, runs, tracking issue
/api/metricsGETmeasured process and workload metrics
/api/devexGETDevEx indicators from the persisted run-outcome series
/api/securityGETmesh CA fingerprint and expiry per namespace

Agents and runs

RouteMethodsPurpose
/api/agentsGETthe agent roster and the inference tiers
/api/agent-configGETthe app agents’ settings and OpenBias rules, read from each repo’s HEAD
/api/agent-runsGETPR-triggered agent runs per repo (GitHub Actions)
/api/agent-runs/logsGETone run’s unzipped log text
/api/runsGETevery agent run across kinds, repos, CronJobs and app agents
/api/reviewsGETrunning and past reviews, with findings per review type
/api/reviews/{type}/{runId}[/detail]GETone review run’s findings; /detail adds what the agents posted on GitHub
/api/agent-schedulesGETeach agent’s cadence and arming, shown in the Schedule & runs section of its page
/api/agent-schedules/{name}PUTarm or disarm an agent (privileged)
/api/agent-healthPOSTthe apps’ rolled-up agent health (machine ingest)
/api/session-runsPOSTtide session run reports (agent report)
/api/session-commandsPOST, GETthe remote-control queue a workstation pulls from: enqueue for yourself, or long-poll a claim
/api/session-commands/{id}/resultPOSTa claimed command’s result
/api/session-queueGET, POSTthe browser’s view of your queue, and the browser’s enqueue path (cookie)
/api/governance-runsGETrun history of the governance-family agents; ?repo= filters

Models and inference (DataEx)

RouteMethodsPurpose
/api/inferenceGETthe inference plane as deployed: model, quantisation, context, engine, OOM history
/api/inference/hostsGETDataEx › Agents › Models & inference: each host and the tiers it serves, resolved live from the model router, servefwd and the engines; a card only where it describes the loaded model; usage from the router since it started
/api/modelsGETmodel cards joined with live tier state, a health verdict, token use and tenant CU
/api/model-readinessGETwhether the models the AI features call (general, guard and reranker tiers) are ready, for the banner over every page: the model router’s /health and its ops doctor’s engine health. Never calls or wakes a model
/api/dataex/tasksGETRead by Ask TIDE’s dataex_tasks lookup (the DataEx › Tasks page was removed 2026-11-05): each tier’s measured decode rate and the model router’s per-backend queues. Each part carries its own source, reason and age
/api/serversGETClusters › Nodes & servers: the k0s nodes and the declared off-cluster servers (ConfigMap tide-system/tide-servers), each read through servefwd, with the router tiers it serves
/api/training-runsGETDataEx › Tasks › Training: every rtrain run on each declared training server (progress, losses, ETA, adapter, base + revision), read from the server’s gate through servefwd
/api/training-configGETDataEx › Tasks › Training › Configuration: adapters.yaml + serve.yaml from the training server’s configRepo at its default-branch head, read-only, with what an edit path needs
/api/finopsGETallocated compute attributed by initiative and tenant

Connections, runners and providers (DataEx)

RouteMethodsPurpose
/api/connectionsGET, POSTlist or create tenant data-source connections
/api/connections/{id}GET, PUT, DELETEone connection
/api/connection-typesGETthe connector catalog: settings and credential keys per type
/api/runnersGET, POSTdata-access runners: list, or enrol (a one-time ticket is shown once)
/api/runners/{id}/…POST, PATCHtoken, connect, revoke, and address or label changes
/api/runner-tokens/{id}DELETErevoke an unused enrolment token
/api/connectors/statusGETthe cached connector probe; never dials
/api/connectors/status/refreshPOSTrun the connector probe (the one path here that dials; privileged)
/api/providersGET, POSTcloud-provider config and the connectors TIDE publishes
/api/providers/gcp/statusGETthe live GCP fleet link (opt-in)
/api/githubGET, POSTthe GitHub configuration shown on Admin › Platform settings

The DataEx Connections and Runners pages now use the shared gRPC-web services; the /api/connections*, /api/runners* and /api/runner-tokens/* routes stay for one release as deprecated aliases (the tide connection register CLI uses /api/connections).

Trust (DataEx)

RouteMethodsPurpose
/api/harnessGETmeasures and compliance joined into actionable findings
/api/harness/{id}/actPOSTact on a finding: admin, audit-before-act, idempotent
/api/guardrailsGET, PUTautonomy per action class, and the hard guardrails
/api/measuresGETthe platform self-assessment: judged categories and one remediation measure per failing one

Intelligence

RouteMethodsPurpose
/api/swarmGETagent swarm: fleet health, roster, run and latency rollup across apps
/api/domainsGETdata domains clustered from the connection registry
/api/governanceGETestate governance: ownership, credential storage, namespace posture
/api/data-lineageGETdeclared topology and observed flows
/api/data-lineage/edgesPOSTthe apps’ observed-lineage ingest (machine token)
/api/complianceGETper-control findings; never a score
/api/maturityGETfive measured dimensions, and a composite only when all five are measured
/api/rules-reconGETbusiness-rule reconciliation; ?tenant=
/api/rules-recon/inputsGETthe recon agent’s read door (TIDE_RECON_INGEST_TOKEN)
/api/rules-recon/reportPOSTthe recon agent’s report (TIDE_RECON_INGEST_TOKEN)
/api/data-governance-findingsGET, POSTthe datagov findings: session read, agent-report write
/api/data-governance-estateGETthe datagov agent’s read door: structure and counts only (agent report token)
/api/judgementGETsubmitted findings and TIDE’s verdicts on them
/api/judgement/submissionsPOSTan external platform’s findings (TIDE_JUDGEMENT_INGEST_TOKEN); any verdict on the wire is discarded
/api/judgementsGET, POSTthe judge agent’s verdicts (agent report token for POST)
/api/playbook-runs/step-reportPOSTa dispatched agent reports its playbook step
/api/playbook-eventsPOSTan agent raises a playbook event

FORGE

RouteMethodsPurpose
/api/forge-studioGETwhat FORGE › Studio can do for the caller: GitHub writes (FORGE_OWNER_EMAIL), the GitHub App, the planner
/api/forge-deleteGET, POSTGET: what deleting a FORGE app removes; POST: delete it after the typed-name confirmation

Billing

RouteMethodsPurpose
/api/plansGETthe public plan catalogue of one product, ?product=face|pulse|core (empty is FACE). See Billing
/api/signupPOSTpublic self-serve signup: a pending subscription and a checkout
/api/checkoutPOSTa quote and, when configured, a Stripe checkout for the signed-in person
/api/billing/seatsGET, POST, DELETEwho holds the seats on the signed-in purchaser’s subscription
/api/stripe/webhookPOSTStripe events into the subscription store

gRPC-web on /

The root handler serves, in order: gRPC-web (dispatched by content type, so it needs no route of its own), the Flutter bundle from CONSOLE_WEB_DIR, and else the HTML dashboard fallback. The gRPC-web services run in the same process, on the same origin and session, with no CORS: a foreign Origin is refused with 403. They are:

  • TIDE’s own: CapexService, GovernanceService, WorkspaceService, PlaybookService, ResolveService (an alias of the estate service) and AskService;
  • the shared services TIDE mounts: runink.ui.estate.v1.EstateService, runink.ui.profile.v1.ProfileService, and the datasources ConnectionsService and RunnersService.