Skip to content
API Reference

API Reference

These are the Runink TIDE-side contracts with FORGE. FORGE’s services (forge.v1) run inside the TIDE console and are served on the console’s own same-origin gRPC-web endpoint, on the console session, like every other console service. There is no separate FORGE service, no forge-system namespace and no proxy in front of it.

/forge/ and every path under it fall through to the console shell like any unknown path, so the only door to FORGE is the console’s own, behind the FORGE_OWNER_EMAIL gate on GitHub writes.

GET /api/forge-studio: what the studio can do for you

A read, behind a TIDE session, for platform users only. It returns one entry per capability, each with the setting that decides it and, when it is missing, the console’s own sentence:

{
  "githubWrites": {"available": false, "variable": "FORGE_OWNER_EMAIL", "reason": "…"},
  "githubApp":    {"available": true,  "variable": "TIDE_GH_APP_ID"},
  "planner":      {"available": true,  "variable": "INFERENCE_REMOTE_URL"}
}
CapabilityMissing whenEffect
githubWritesFORGE_OWNER_EMAIL is unset (nobody may) or does not name you; or the console has no sign-inFORGE will not create repositories, file work or push forge.yaml for you. The same predicate gates the write RPCs, so the page and the gate cannot disagree
githubAppThe console’s GitHub App credentials are not set (TIDE_GH_APP_ID / TIDE_GH_APP_PRIVATE_KEY; the TIDE_GH_APP_* and GITHUB_APP_* spellings are accepted)FORGE cannot create repositories or read the org’s apps
plannerINFERENCE_REMOTE_URL is unset, or the model router does not answer GET /v1/modelsThe planner cannot propose a plan

The router check reuses the console’s cached model-endpoint probe and never makes a completion. Nothing on this endpoint calls GitHub. FORGE › Studio shows one notice per missing capability above the canvas.

The FORGE studio reads each app’s build state from its core/ci commit status. FORGE is the only producer of forge issues.

Studio link parameters

The link the console hands FORGE › Studio, as /forge/?…: the path is only the carrier, the canvas reads the parameters. The contract belongs to FORGE. Values are percent-encoded, spaces as %20, and appear in a fixed order: chat, app, panel, cmd.

ParamMeaning
chatThe chat (= project) to open: a FORGE chat id (c- + 16 hex, or repo-<app name>), or new for an empty chat. View state: FORGE keeps it, so a reload shows the same chat
panelThe side panel to open: components, draft or details. View state
appLegacy, from before chats: an app name (^[a-z0-9][a-z0-9-]{0,99}$), which FORGE opens as the one-lane chat repo-<name>. Kept so old links still work. TIDE sends chat
cmdA command FORGE prefills into its console and never sends. FORGE strips it from its address after reading it, and caps it at 8000 UTF-8 bytes

Console deep links: /?tab=forgeStudio&chat=<id> (and the legacy &app=<name>&panel=<panel>).