Scriptum API Reference
Last validated: 2026-05-14
This API reference is now split by domain so users can find request fields, response behavior, caveats, and examples faster.
Read By Domain
- 04-api-reference/01-transport-auth-and-conventions.md
- gRPC vs HTTP access model, auth metadata, pagination/version conventions, error guidance.
- 04-api-reference/02-scripts-and-versioning.md
- Script CRUD, draft lifecycle, compile/publish/rollback, version and code retrieval.
- 04-api-reference/03-threads-and-execution.md
- Thread lifecycle, watch semantics, pause/resume behavior, execution caveats.
- 04-api-reference/04-results-and-streaming.md
- Unary vs streaming result APIs, chunking behavior, step-level retrieval strategy.
- 04-api-reference/05-config-tools-templates-health.md
- Tenant env, script env overlays, tools/templates endpoints, health checks.
Status Legend
- Implemented: wired and callable in current API runtime.
- Partial: callable with known behavioral limits or contract drift.
- Unimplemented: RPC currently returns
UNIMPLEMENTED.
Quick Usage Guidance
- Prefer gRPC clients (or CLI) for business operations in this repo deployment.
- Use HTTP management endpoints (
/health,/ready,/metrics) for service probes. - If your deployment includes a gateway, HTTP annotation paths in proto can be used as REST contracts.
- For large outputs, call unary result first, then switch to streaming when truncated.