You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browse filesBrowse the repository at this point in the historyBrowse files
authored
docs: document provider credits/pricing, app releases, and extension download (#4717)
Seven HTTP routes had no mention on any documentation page. Adds them to
the api-reference.md endpoint matrix with a worked example each, plus the
env var one of them reads.
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/api-reference.md
+213Lines changed: 213 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,13 @@ For detailed schemas, see [Chat API](chat-api.md) and [Workflow API](workflow-ap
37
37
| Examples |`/api/workflows/examples/thumbnails/{filename}`|`GET`| none | no | Example thumbnail; `.jpg` and `.png` only |
38
38
| Assets |`/api/assets/{id}/extract-audio`|`POST`| Depends on `AUTH_PROVIDER`| no | Extract a video asset's audio track into a new WAV asset |
39
39
| Assets |`/api/assets/packages/{package}/{file}`|`GET`| none | streaming | Bytes behind a `package://` ref, from a node pack's assets directory |
40
+
| Apps |`/api/applications/{id}/released-document`|`GET`| Depends on `AUTH_PROVIDER`| no | The snapshot a published app should run, with each operation's pinned graph; `null` when nothing is published |
41
+
| Providers |`/api/fal/credits`|`GET`| Depends on `AUTH_PROVIDER`| no | The server's fal.ai account balance; `204` when no `FAL_API_KEY` is configured |
42
+
| Providers |`/api/fal/pricing`|`GET`| Depends on `AUTH_PROVIDER`| no | Unit price per fal.ai endpoint, one or more `?endpoint_id=`; cached an hour |
43
+
| Providers |`/api/kie/credits`|`GET`| Depends on `AUTH_PROVIDER`| no | The server's kie.ai credit balance; `204` when no `KIE_API_KEY` is configured |
44
+
| Providers |`/api/kie/pricing`|`GET`| Depends on `AUTH_PROVIDER`| no | Credit price per kie.ai model, one or more `?model_id=`; cached an hour |
45
+
| Providers |`/api/kie/resolve-dynamic-schema`|`POST`| Depends on `AUTH_PROVIDER`| no | Pasted kie.ai model docs to a node's dynamic properties, inputs, and outputs |
46
+
| Extension |`/api/extension/download`|`GET`| Depends on `AUTH_PROVIDER`| no | The built Chrome extension as a zip; `404` when the server has no build |
40
47
| Workflow WS |`/ws`| WebSocket | Bearer header or `api_key` query when enforced | yes | Workflow execution, chat, job control, live updates (MessagePack or JSON) |
41
48
| Agent WS |`/ws/agent`| WebSocket | Bearer header or `api_key` query when enforced | yes | Agent runtime |
Copy file name to clipboardExpand all lines: docs/chrome-extension.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,17 @@ The extension icon appears in your toolbar. Click it to open the popup, which sh
67
67
68
68
> **Standalone package**: `chrome-extension/` is intentionally outside the root npm workspace, Turbo pipeline, and CI — it has its own `package.json` and is built on demand. `npm run build:packages` at the repo root does **not** build it.
69
69
70
+
### Downloading a prebuilt copy
71
+
72
+
A server that already has the extension built will hand it to you zipped, which saves cloning the repo on the machine running Chrome — the desktop app's install helper uses this.
Load `nodetool-extension/` with **Load unpacked**. A server with no build to hand out answers `404` with `{"detail": "Extension build not found"}` — build from source as above, or point the server at an existing build with `NODETOOL_EXTENSION_DIST`. See [API Reference](api-reference.md#downloading-the-chrome-extension).
Copy file name to clipboardExpand all lines: docs/configuration.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -171,6 +171,7 @@ Security notes:
171
171
|`NODETOOL_WS_DRAIN_TIMEOUT_MS`| How long a send waits for a slow reader before it is dropped | no | Default `30000`; the drop uses code `1001` so clients reconnect |
172
172
|`NODETOOL_WS_MAX_QUEUED_FRAMES`| Undelivered inbound frames per connection before it is closed | no | Default `2000`; closes with code `1008`|
173
173
|`NODETOOL_DISABLE_TRIGGERS`| Skip trigger ingestion on this process (no dispatcher, scheduler, file watcher, or webhook route) | no | Ingestion is **on** by default. Set to `1` when a second server shares one database, or for an embedded server that must not start background work |
174
+
|`NODETOOL_EXTENSION_DIST`| Directory holding the built Chrome extension served by `/api/extension/download`| no | Set by the desktop app to its bundled copy. When unset (or pointing at a directory with no `manifest.json`), the server walks up from its own directory and the working directory looking for `chrome-extension/dist`. See [Chrome Extension](chrome-extension.md#downloading-a-prebuilt-copy)|
174
175
|`LOG_LEVEL` / `NODETOOL_LOG_LEVEL`| Logging level | no | Defaults to `info` (`NODETOOL_LOG_LEVEL` takes precedence) |
175
176
|`SECRETS_MASTER_KEY`| Master key for secret encryption | yes | See [Secret Storage and Master Key](#secret-storage-and-master-key)|
176
177
|`RUNPOD_API_KEY`| RunPod deployments | yes | Used by CLI and providers |
0 commit comments