Interface 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 setting | Reference |
|---|---|
| Shell commands and local execution | CLI |
| Programmatic service calls | Python |
| Client addresses, tokens, and timeouts | Client configuration |
| Application, component, and Job assembly | Server configuration |
| HTTP discovery and JobResponse | API overview |
| Task submission, state, context, and graphs | Task API |
| Live progress and log events | SSE events |
| Workspace listing and previews | Workspace API |
| Machines and resource readings | Machine API |
| Plugin management and snapshot synchronization | Plugins and synchronization API |
| Built-in Agent sessions | Agent 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 transport status, JobResponse success, and Task terminal state answer different questions. A successful submit returns a TaskHandle; use its task_id and run_id to wait for that execution and inspect its final state. Discover schemas on the connected service because installed plugins and configured Jobs determine available capabilities.
For implementation contracts, see Task contracts, plugin manifests, and research artifacts under Developers. For execution semantics, see Jobs and Tasks.