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 |
|---|---|
| CLI 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 execution, 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 |
| 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 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
| Implementation | Reference |
|---|---|
| Task inputs, outputs, identity, and lifecycle | Task contracts |
| Plugin packaging, registration, and discovery | Plugin manifest |
| Research artifacts and Studio views | Research artifact contracts |
For plugin authoring steps, see the development and operations guide. For execution semantics, see Jobs and Tasks.