2026-07-05 03:09:32 +00:00
# Consumer Integration Overview
2026-07-04 14:24:06 +00:00
2026-07-28 14:21:19 +00:00
Scriptorium exposes executable interfaces. Choose between a local subprocess
and the HTTP service according to the boundary your application needs.
2026-07-04 14:24:06 +00:00
2026-07-26 14:16:09 +00:00
| Interface | Use when |
2026-07-05 03:09:32 +00:00
| --- | --- |
2026-07-28 14:21:19 +00:00
| CLI subprocess | The consumer needs a synchronous local process boundary or prepared output. |
2026-07-26 14:16:09 +00:00
| HTTP API | The consumer needs a service boundary or remote access. |
2026-07-05 03:09:32 +00:00
2026-07-26 14:16:09 +00:00
- CLI subprocess: [subprocess integration ](../integrations/subprocess.md )
- HTTP service: [HTTP API reference ](../api.md )
2026-07-28 14:21:19 +00:00
- Application configuration: [configuration reference ](../config.md )
Go applications that need an in-process prompt framework should import
2026-11-18 19:25:54 +00:00
`go.maximumdirect.net/promptkit` directly. The tagged
[Promptkit Go consumer guide ](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md )
2026-07-28 14:21:19 +00:00
owns that interface; Scriptorium does not provide a Go library package.
2026-07-28 19:43:57 +00:00
Consumers arriving from the former Scriptorium Go API should follow the
[migration guide ](migrating-to-promptkit.md ).
2026-07-05 03:09:32 +00:00
## Consumer Responsibilities
Consumers are responsible for:
2026-07-26 14:16:09 +00:00
- selecting and deploying prompt, profile, and schema assets;
- supplying required inputs and template variables;
2026-07-28 14:21:19 +00:00
- supplying credentials through the chosen interface;
- protecting rendered prompts and generated artifacts as potentially
sensitive;
2026-07-26 14:16:09 +00:00
- deciding whether validation-failed output is usable; and
- retrying only when another model call is acceptable.
2026-07-28 14:21:19 +00:00
Scriptorium does not persist run state. A retry can produce different output
and can incur another provider request. CLI exits belong to the
[CLI reference ](../cli.md ), HTTP status behavior belongs to the
[HTTP API reference ](../api.md ), and framework semantics belong to
2026-11-18 19:25:54 +00:00
[PromptKit v0.23.2 ](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md ).