curl --request POST \
--url https://your-instance.example.com/api/prompts/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Leasing follow-up assistant",
"prompt": "<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>",
"description": "Follow up with leads 24h after their last response.",
"temperature": 0.7,
"responseTime": 45,
"isHidden": false
}
'import requests
url = "https://your-instance.example.com/api/prompts/create"
payload = {
"name": "Leasing follow-up assistant",
"prompt": "<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>",
"description": "Follow up with leads 24h after their last response.",
"temperature": 0.7,
"responseTime": 45,
"isHidden": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Leasing follow-up assistant',
prompt: '<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>',
description: 'Follow up with leads 24h after their last response.',
temperature: 0.7,
responseTime: 45,
isHidden: false
})
};
fetch('https://your-instance.example.com/api/prompts/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/prompts/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Leasing follow-up assistant',
'prompt' => '<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>',
'description' => 'Follow up with leads 24h after their last response.',
'temperature' => 0.7,
'responseTime' => 45,
'isHidden' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/prompts/create"
payload := strings.NewReader("{\n \"name\": \"Leasing follow-up assistant\",\n \"prompt\": \"<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>\",\n \"description\": \"Follow up with leads 24h after their last response.\",\n \"temperature\": 0.7,\n \"responseTime\": 45,\n \"isHidden\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/prompts/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Leasing follow-up assistant\",\n \"prompt\": \"<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>\",\n \"description\": \"Follow up with leads 24h after their last response.\",\n \"temperature\": 0.7,\n \"responseTime\": 45,\n \"isHidden\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/prompts/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Leasing follow-up assistant\",\n \"prompt\": \"<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>\",\n \"description\": \"Follow up with leads 24h after their last response.\",\n \"temperature\": 0.7,\n \"responseTime\": 45,\n \"isHidden\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "Prompt created successfully",
"prompt": {
"_id": "64d2f9c5e8a1d4e001a0b1c2",
"name": "Maple Court — Tour confirm",
"description": "Confirms a tour booking and proposes alternates.",
"prompt": "<prompt><role>Leasing assistant</role><goal>Confirm tour.</goal></prompt>",
"temperature": 0.3,
"responseTime": 30,
"isHidden": false,
"voiceAI": {
"enabled": false
},
"createdBy": "64a1b2c3d4e5f60012345679",
"organizationId": "64a1b2c3d4e5f60012345678",
"createdAt": "2026-05-20T15:04:01.135Z",
"updatedAt": "2026-05-20T15:04:01.135Z"
}
}{
"error": "Prompt not found",
"details": "No prompt with id 5f7b1c2e8a1d4e0012c3b4a5 belongs to this user."
}Create a new prompt
Creates a new Prompt document owned by the calling user and organization. The body becomes the live prompt content; subsequent edits create versions, not new prompts.
curl --request POST \
--url https://your-instance.example.com/api/prompts/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Leasing follow-up assistant",
"prompt": "<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>",
"description": "Follow up with leads 24h after their last response.",
"temperature": 0.7,
"responseTime": 45,
"isHidden": false
}
'import requests
url = "https://your-instance.example.com/api/prompts/create"
payload = {
"name": "Leasing follow-up assistant",
"prompt": "<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>",
"description": "Follow up with leads 24h after their last response.",
"temperature": 0.7,
"responseTime": 45,
"isHidden": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Leasing follow-up assistant',
prompt: '<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>',
description: 'Follow up with leads 24h after their last response.',
temperature: 0.7,
responseTime: 45,
isHidden: false
})
};
fetch('https://your-instance.example.com/api/prompts/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/prompts/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Leasing follow-up assistant',
'prompt' => '<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>',
'description' => 'Follow up with leads 24h after their last response.',
'temperature' => 0.7,
'responseTime' => 45,
'isHidden' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/prompts/create"
payload := strings.NewReader("{\n \"name\": \"Leasing follow-up assistant\",\n \"prompt\": \"<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>\",\n \"description\": \"Follow up with leads 24h after their last response.\",\n \"temperature\": 0.7,\n \"responseTime\": 45,\n \"isHidden\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/prompts/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Leasing follow-up assistant\",\n \"prompt\": \"<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>\",\n \"description\": \"Follow up with leads 24h after their last response.\",\n \"temperature\": 0.7,\n \"responseTime\": 45,\n \"isHidden\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/prompts/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Leasing follow-up assistant\",\n \"prompt\": \"<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>\",\n \"description\": \"Follow up with leads 24h after their last response.\",\n \"temperature\": 0.7,\n \"responseTime\": 45,\n \"isHidden\": false\n}"
response = http.request(request)
puts response.read_body{
"message": "Prompt created successfully",
"prompt": {
"_id": "64d2f9c5e8a1d4e001a0b1c2",
"name": "Maple Court — Tour confirm",
"description": "Confirms a tour booking and proposes alternates.",
"prompt": "<prompt><role>Leasing assistant</role><goal>Confirm tour.</goal></prompt>",
"temperature": 0.3,
"responseTime": 30,
"isHidden": false,
"voiceAI": {
"enabled": false
},
"createdBy": "64a1b2c3d4e5f60012345679",
"organizationId": "64a1b2c3d4e5f60012345678",
"createdAt": "2026-05-20T15:04:01.135Z",
"updatedAt": "2026-05-20T15:04:01.135Z"
}
}{
"error": "Prompt not found",
"details": "No prompt with id 5f7b1c2e8a1d4e0012c3b4a5 belongs to this user."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Human-readable prompt name shown in pickers and lists.
XML prompt body driving the AI agent.
Target reply latency in seconds; the engine throttles streaming to roughly this duration.
Short summary of the prompt's purpose; surfaced in summary lists and pickers.
Hidden prompts are excluded from non-admin lists and approval flows.
Sampling temperature (0-1). Lower = more deterministic.
Response
Prompt created successfully
Returned by POST /api/prompts/create.
Prompt document as stored in the Prompt collection. Returned shape varies slightly per endpoint (some list/summary endpoints project a subset of fields).
Show child attributes
Show child attributes
{
"_id": "5f7b1c2e8a1d4e0012c3b4a5",
"name": "Leasing follow-up assistant",
"prompt": "<prompt><role>Leasing assistant</role><goal>Re-engage leads 24h after their last reply.</goal></prompt>",
"description": "Follow up with leads 24h after their last response.",
"temperature": 0.7,
"responseTime": 45,
"isHidden": false,
"tools": [{ "name": "book_tour" }],
"toolConfigs": { "book_tour": { "requireApproval": true } },
"organizationId": "64a1b2c3d4e5f60012345678",
"userId": "64a1b2c3d4e5f60012345679",
"createdAt": "2026-03-12T14:22:10.000Z",
"updatedAt": "2026-04-22T10:14:00.000Z"
}