v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB
Prompts

Create Prompt

Create a new prompt that you can use across your AI applications. Build prompts from one or more components, and use handlebars-style variables like {{userName}} for personalization.

Safe by Default: Creating a prompt creates a new version but doesn't activate it. Your production prompts stay unchanged until you explicitly activate the new version (via the UI or when you reference it in the Messages API). This lets you test and prepare new prompts without risk.

Versioning: Every prompt is immutable and versioned with fingerprinting, so you can safely iterate and track changes over time.

post/prompts

Request body

externalPromptIdstring

Your external identifier for the prompt.

namestring required

Prompt name.

descriptionstring

Prompt description.

productIdstring uuid required

Product this prompt will map to.

rolestring required

Role key in the product mapping (e.g. "agent tool").

source'customer' | 'participant' | 'greenflash' | 'agent'

Prompt source.

Response

Prompt created successfully

externalPromptIdstring

The external prompt ID.

promptIdstring uuid required

The created prompt ID.

versionIdstring uuid required

The created version ID. Version is created but not activated (activation happens via UI or Messages API).

componentIdsstring[] required

The IDs of the created prompt components.