Skip to content

docs(tool-executions): say why this page calls two different hosts - #1159

Closed
josebarrueta wants to merge 1 commit into
add-doc-screenshotsfrom
plt-3107-two-host-note
Closed

docs(tool-executions): say why this page calls two different hosts#1159
josebarrueta wants to merge 1 commit into
add-doc-screenshotsfrom
plt-3107-two-host-note

Conversation

@josebarrueta

@josebarrueta josebarrueta commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

One sentence, split out from #1157 so it can be rejected on its own — it is a judgement call about how the docs explain Arcade's API surface, not a correction like the rest of that PR.

Stacked on #1157add-doc-screenshotsmain.

Why

After #1157 the page is correct but reads oddly. It says the base URL is https://api.arcade.dev, and thirty lines later calls https://cloud.arcade.dev. Both are right:

Call Service Host Prefix
tool_executions (read history) Engine api.arcade.dev /v1/...
logging-config (change policy) Control plane cloud.arcade.dev /api/v1/...

Verified against the harness clients, which are the source of truth for these paths — engine.ts builds v1/orgs/{org}/projects/{proj}, coordinator.ts builds api/v1/orgs/{org}.

A reader who notices the difference cannot tell it from a typo, and guessing wrong costs a 404 on a path that looks right. That is not hypothetical: I made exactly this mistake writing #1141, applying the Engine's convention to a control-plane endpoint. It shipped and stood until this week.

What it says

Reading history and changing the policy are two different services, so they answer on two different hosts. Execution history is served by the Engine at https://api.arcade.dev; the recording and retention settings below belong to your organization and are served by the control plane at https://cloud.arcade.dev, alongside the audit log API. The host and the path prefix differ together — /v1/... on the Engine, /api/v1/... on the control plane.

@evantahler — worth your call on two things:

  1. Is this the page's job? The split is site-wide, not specific to tool executions. If it belongs in a shared API-reference page instead, say so and I will move it there and drop this.
  2. Is "control plane" the right customer-facing word? It is our internal name for the Coordinator. If the docs have an established term, I will use that.

CI note

Generate LLMs.txt fails here, as it does on every PR in this repo since 2026-08-26 — it dies at checkout because secrets.DOCS_PUBLISHABLE_GH_TOKEN resolves empty. Unrelated to this change.


Note

Low Risk
Documentation-only clarification with no runtime or API behavior changes.

Overview
Adds a short note in Read executions from the API so readers are not surprised when the same page uses https://api.arcade.dev for execution history and later https://cloud.arcade.dev for logging policy.

The new copy states that listing/reading tool runs is on the Engine (/v1/...), while org recording and retention settings (and the linked audit log API) live on the control plane (/api/v1/...), and that host and path prefix change together.

Reviewed by Cursor Bugbot for commit 224846d. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 28, 2026 8:22pm

Request Review

@josebarrueta
josebarrueta force-pushed the plt-3107-logging-policy-rename branch from 7fba734 to 18b2a17 Compare August 28, 2026 20:13
@josebarrueta
josebarrueta force-pushed the plt-3107-two-host-note branch from 8b2e3eb to 85c8dd7 Compare August 28, 2026 20:13
Base automatically changed from plt-3107-logging-policy-rename to add-doc-screenshots August 28, 2026 20:18
The page reads history from one host and writes policy to another, thirty
lines apart, with nothing saying why. Both are right — history is served by the
Engine, the organization's settings by the control plane — but a reader who
notices the difference has no way to tell it from a typo, and guessing wrong
costs them a 404 on a path that looks correct.

Named once, where the first host appears, with the path prefixes attached
because they differ together.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@josebarrueta
josebarrueta force-pushed the plt-3107-two-host-note branch from 85c8dd7 to 224846d Compare August 28, 2026 20:20
@josebarrueta

Copy link
Copy Markdown
Contributor Author

Withdrawing — not needed. @evantahler no action for you here; you can ignore the two questions I left above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant