Skip to main content
POST
Create a new prompt

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Human-readable prompt name shown in pickers and lists.

prompt
string

XML prompt body driving the AI agent.

responseTime
number

Target reply latency in seconds; the engine throttles streaming to roughly this duration.

description
string

Short summary of the prompt's purpose; surfaced in summary lists and pickers.

isHidden
boolean

Hidden prompts are excluded from non-admin lists and approval flows.

temperature
number

Sampling temperature (0-1). Lower = more deterministic.

Response

Prompt created successfully

Returned by POST /api/prompts/create.

message
string
required
prompt
object
required

Prompt document as stored in the Prompt collection. Returned shape varies slightly per endpoint (some list/summary endpoints project a subset of fields).

Example: