Skip to main content
Use the HTTP API when a service, notebook, dashboard, or custom runtime needs stable JSON contracts and does not want to shell out to sf.

1. Base URL

2. Public reads

Start broad with query or world state, then inspect one ticker before acting on it.

3. Authenticated reads

Authenticated surfaces are scoped to the key owner. Do not pass arbitrary user ids from clients.

4. Discover canonical SDK and Agent tools

Use /api/contracts/tools for SDK and Agent SDK canonical tool names, side-effect classes, cost classes, replay metadata, and auth requirements. /api/tools is broader compatibility inventory.

5. Minimal service wrapper

Next steps

REST API overview

Endpoint groups and response style.

Direct API access

Curl, TypeScript, Python, and service patterns.

SDK quickstart

Use typed TypeScript wrappers.

Contract tools

Canonical SDK and Agent manifest.