1.0 KiB
Consumer API Overview
Scriptorium can be used by consumers through three implemented surfaces:
- CLI commands, documented in CLI reference.
- HTTP
POST /v1/runs, documented in HTTP API reference. - Go package
gitea.maximumdirect.net/eric/scriptorium, documented in pkg-scriptorium.
The Go package is the typed in-process API. It prepares prompts, runs prompts, accepts file or inline artifacts, supports per-request execution overrides, and exposes stable public errors for errors.Is.
Use the Go package when the caller is a Go program that wants typed requests/results, context cancellation, repeated calls without subprocess overhead, or fake LLM injection for tests. Use the CLI or HTTP surfaces when process isolation, language neutrality, or an HTTP boundary is preferred.
Raw API key values are not accepted in public payloads and are not returned in prepared or run results. Execution profiles may reference an environment variable name through api_key_env.