Skip to content

Reference ​

Use reference pages to look up command syntax, configuration fields, responses, and events. For a first execution, follow the quickstart; for a complete research chain, follow the research workflow.

Choose an interface ​

Interface or settingReference
CLI commands and local executionCLI
Programmatic service callsPython
Client addresses, tokens, and timeoutsClient configuration
Application, component, and Job assemblyServer configuration
HTTP discovery and JobResponseAPI overview
Task execution, state, context, and graphsTask API
Live progress and log eventsSSE events
Workspace listing and previewsWorkspace API
Machines and resource readingsMachine API
Built-in Agent sessionsAgent API

External agents discover service tools through MCP integration. MCP exposes public Jobs; live SSE uses the HTTP event endpoints.

Read responses at the right layer ​

HTTP status, JobResponse.success, command exit_code and Task state answer different questions. Native exec waits and returns business output; remote cli returns stdout/stderr/exit_code. Observe Task ID and started_at separately and discover actual schemas on the selected service.

Extension contracts ​

ImplementationReference
Task inputs, outputs, identity, and lifecycleTask contracts
Plugin packaging, registration, and discoveryPlugin manifest
Research artifacts and Studio viewsResearch artifact contracts

For plugin authoring steps, see the development and operations guide. For execution semantics, see Jobs and Tasks.

Agent-native quant research.