Compute reference
Where to find exact Compute API paths, schemas, limits, job states, finance mappings and the impact report contract.
Your existing AI agent keeps the goal, context, edits, native builds and tests, and final decisions. The Compute Kit prepares permitted work and connects an approved compatible MCP or API interface. People-owned participating Macs process supported work, and your agent reviews the returned result.
Choose the lookup family that matches your question. Use the operation tables for method, path, scope, and schema; use the contract pages for exact fields, limits, states, and integration rules.
| Question | Start here |
|---|---|
| Which operation, method, path, or permission do I use? | Work API or Management API |
| Which request or response fields, media types, or identifiers are valid? | Schemas or Formats |
| Which bound, state, or reason explains the response? | Limits or States and reason codes |
| Which finance or impact integration record do I retrieve or map? | Finance API, Finance mappings, or Impact Reports API |
Monthly impact reporting has its own reporting:read API or approved report-file path. It is separate
from the five Work MCP tools and does not add a sixth tool.
APIs
| Reference | Owns |
|---|---|
| Work API | Quote/job/batch/result work endpoints |
| Management API | Account/team/billing management endpoints and scopes |
| Finance API | Finance reads, mappings and sync records |
| Impact Reports API | Immutable monthly impact report retrieval |
Contracts and limits
A schema limit does not promise capacity. Seeing a method in OpenAPI does not grant permission to call it. Always read the required scope and current account authority with the endpoint.
Use the canonical machine-readable OpenAPI document for exact wire definitions. These guides add usage context and safety boundaries around that authority.
For the supplied local modules and workflow guides, see Kit contents. For exact TypeScript helper signatures, use the Kit helper reference.