Skip to main content
A prompt is reusable message text you can attach to a model or apply globally. Reads are scoped by workspace_id. Reads need prompts:read and writes need prompts:write.

List prompts

string
Limit results to one workspace.
string
Match prompts whose name contains this value.
string
SYSTEM, USER, or ASSISTANT.
string
PRODUCTION, STAGING, EVALUATION, or EXPERIMENTS.
object
The model the prompt is attached to, as { id, name, display_name }, or null when the prompt is global.

Get a prompt

Create a prompt

Creates land in your account’s default workspace. A workspace_id in the body is ignored.
string
required
A name for the prompt.
string
required
The prompt text.
string
One of SYSTEM, USER, or ASSISTANT.
string | null
Attach the prompt to a specific model, or leave it null.
boolean
Apply the prompt across the workspace.
boolean
Whether the prompt is active.
integer
The order the prompt is applied in.
string | null
One of PRODUCTION, STAGING, EVALUATION, EXPERIMENTS, or null.

Update a prompt

PATCH is a full replace, not a merge. It validates the same schema as create, so name and content are required on every update.
The response carries no body beyond { "success": true }. The SDK re-reads the prompt after a write.

Delete a prompt