Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 2.43 KB

File metadata and controls

17 lines (11 loc) · 2.43 KB

API namespaces and credentials

Core serves three namespaces. Each has one kind of caller and its own credential, and a credential works only in its own namespace.

Namespace Caller Credential Contents Owner
/v1 Applications: business systems and the official OpenAI SDK Project API key Exactly the 58 method and path pairs of the pinned official Agents API, listed in upstream-routes.json. Core-only fields sit inside x_agents_core: harness, model_provider, harness_config, environment, and the read-only Session installation Agents API guide
/core/v1 Web's console server and operator scripts Core key Installation facts, Projects and keys, resource reads and deletion, Session archive, executor credentials, default models, metrics, audit, sandbox deployment and nodes Core administration API
/api/v1 Nodes, Runtime daemons, self-hosted executors and their installers Machine credentials: node enrollment tokens and node credentials, installation grants, executor credentials, and daemon credentials. Each works only on its own routes Machine bootstrap and connections under /api/v1/sandbox-node/* and /api/v1/agent-daemon/*, including WebSockets, and the public native installer downloads Machine connection API

A credential used in another namespace gets 401: a Project API key on /core/v1 or /api/v1, the Core key on /v1 or /api/v1. How Projects and keys behave is in Projects own assets.

Routing. The reverse proxy sends /v1 and /api/v1 to Core and everything else to Web (proxy setup). Browsers reach /core/v1 only through Web's console server, which adds the Core key after sign-in and answers 404 for /v1 and /api/v1 (console server). Operator scripts call /core/v1 on Core's loopback port (script the Core API).

Machine connection API

Nodes, Runtime daemons and the self-hosted installer call /api/v1 with their own credentials. The machine connection API lists every route, caller and credential.