Skip to content

Operations table

Every transport sends a request document through dispatch, which looks the operation up in OPERATIONS, checks the caller's right, decodes the request, calls the LocalApplication method of the same name and encodes the response. The request and response schemas are in the repository's schemas/ directory.

Operation Right Transports HTTP MCP tool
validate read python, cli, http, mcp POST /v1/revisions/{revision_id}/validate validate_revision
commit_change draft python, cli, http, mcp POST /v1/changes commit_change
solve execute python, cli — —
reproduce execute python, cli — —
submit_job execute python, cli, http, mcp POST /v1/jobs submit_job
get_job read python, cli, http, mcp GET /v1/jobs/{job_id} get_job
list_jobs read python, cli, http, mcp GET /v1/jobs list_jobs
list_job_events read python, cli, http, mcp GET /v1/jobs/{job_id}/events list_job_events
wait_job read python, cli, http, mcp GET /v1/jobs/{job_id}/wait wait_job
cancel_job execute python, cli, http, mcp POST /v1/jobs/{job_id}/cancel cancel_job
get_job_result read python, cli, http, mcp GET /v1/jobs/{job_id}/result get_job_result
get_project read python, cli, http, mcp GET /v1/project get_project
list_models read python, cli, http, mcp GET /v1/models list_models
list_revisions read python, cli, http, mcp GET /v1/revisions list_revisions
get_revision read python, cli, http, mcp GET /v1/revisions/{revision_id} get_revision
diff_revisions read python, cli, http, mcp GET /v1/revisions/{from_revision}/diff/{to_revision} diff_revisions
inspect_structure read python, cli, http, mcp GET /v1/revisions/{revision_id}/structure inspect_structure
preview_change read python, cli, http, mcp POST /v1/changes/preview preview_change
get_artifact read python, cli, http, mcp GET /v1/artifacts/{artifact_id} get_artifact
get_stream_table read python, cli, http, mcp GET /v1/jobs/{job_id}/stream-table get_stream_table
list_audit read python, cli, http GET /v1/audit —
explain read python, cli, http, mcp GET /v1/explain/{code} explain
artifact_bytes read python, cli, http GET /v1/artifacts/{artifact_id}/raw —

dispatch

dispatch(app: Dispatchable, name: str, request: Any) -> Any

§4.3: the one path from a request document to a response, for every binding.

Raises ApplicationError carrying a bounded ApiError for every refusal; returns the bounded response document (the raw export: bytes).

Operation dataclass

Operation(
    name: str,
    method: str,
    right: Right,
    request_schema: Mapping[str, Any],
    response_schema: Mapping[str, Any] | None,
    http: tuple[str, str] | None,
    mcp_tool: str | None,
    transports: tuple[Transport, ...],
    description_file: str | None,
    decode: Callable[[Mapping[str, Any]], dict[str, Any]],
    encode: Callable[[Any], Any],
)

One row of §4.3's table.