Skip to content

PromptBundleV1

PromptScript API


Defined in: core/src/types/prompt-bundle.ts:112

A portable, content-hashed prompt bundle, version 1.

contentHash is SHA-256 over the RFC 8785 canonical JSON of every field except contentHash and provenance.

Properties

$schema

$schema: "https://getpromptscript.dev/schema/prompt-bundle/v1.json"

Defined in: core/src/types/prompt-bundle.ts:117

Schema URL, the version tag of the bundle.

Example

"https://getpromptscript.dev/schema/prompt-bundle/v1.json"

contentHash

contentHash: string

Defined in: core/src/types/prompt-bundle.ts:129

Content hash: sha256- plus 64 lowercase hex characters.

Pattern

^sha256-[0-9a-f]{64}$


description

description: string

Defined in: core/src/types/prompt-bundle.ts:124

What the prompt does


governance

governance: GovernanceMeta

Defined in: core/src/types/prompt-bundle.ts:143

Effective governance: the entry value, else the file-level default. Lists are sorted and deduplicated.


id

id: string

Defined in: core/src/types/prompt-bundle.ts:122

Prompt id, <@meta.id>/<key>.

Example

"acme-support/refund-reply"

inputs

inputs: Record<string, PromptBundleInput>

Defined in: core/src/types/prompt-bundle.ts:137

Declared runtime inputs by name


messages

messages: PromptBundleMessage[]

Defined in: core/src/types/prompt-bundle.ts:135

One or two messages, system first.

Min Items

1

Max Items

2


model?

optional model?: PromptBundleModel

Defined in: core/src/types/prompt-bundle.ts:141

Model identity and parameters


output?

optional output?: PromptBundleOutput

Defined in: core/src/types/prompt-bundle.ts:139

Output contract


provenance

provenance: PromptBundleProvenance

Defined in: core/src/types/prompt-bundle.ts:145

Provenance of the messages