Create an ai message
curl --request POST \
--url https://openapi.enginy.ai/v1/ai-variables/ai-messages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"toneId": "<string>",
"model": "<string>",
"outputLength": 5,
"prompt": "<string>",
"description": "<string>",
"splitMessages": true,
"folderId": 123,
"customPromptFieldValues": [
{
"customPromptFieldId": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://openapi.enginy.ai/v1/ai-variables/ai-messages"
payload = {
"name": "<string>",
"toneId": "<string>",
"model": "<string>",
"outputLength": 5,
"prompt": "<string>",
"description": "<string>",
"splitMessages": True,
"folderId": 123,
"customPromptFieldValues": [
{
"customPromptFieldId": "<string>",
"value": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
toneId: '<string>',
model: '<string>',
outputLength: 5,
prompt: '<string>',
description: '<string>',
splitMessages: true,
folderId: 123,
customPromptFieldValues: [{customPromptFieldId: '<string>', value: '<string>'}]
})
};
fetch('https://openapi.enginy.ai/v1/ai-variables/ai-messages', 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://openapi.enginy.ai/v1/ai-variables/ai-messages",
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' => '<string>',
'toneId' => '<string>',
'model' => '<string>',
'outputLength' => 5,
'prompt' => '<string>',
'description' => '<string>',
'splitMessages' => true,
'folderId' => 123,
'customPromptFieldValues' => [
[
'customPromptFieldId' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://openapi.enginy.ai/v1/ai-variables/ai-messages"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"toneId\": \"<string>\",\n \"model\": \"<string>\",\n \"outputLength\": 5,\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"splitMessages\": true,\n \"folderId\": 123,\n \"customPromptFieldValues\": [\n {\n \"customPromptFieldId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://openapi.enginy.ai/v1/ai-variables/ai-messages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"toneId\": \"<string>\",\n \"model\": \"<string>\",\n \"outputLength\": 5,\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"splitMessages\": true,\n \"folderId\": 123,\n \"customPromptFieldValues\": [\n {\n \"customPromptFieldId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.enginy.ai/v1/ai-variables/ai-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"toneId\": \"<string>\",\n \"model\": \"<string>\",\n \"outputLength\": 5,\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"splitMessages\": true,\n \"folderId\": 123,\n \"customPromptFieldValues\": [\n {\n \"customPromptFieldId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {}
}AI Variables
Create an ai message
Creates a non-prompt-library (workspace-owned) entry. Requires the AI variable split to be enabled for the workspace; otherwise returns 403 and the legacy POST /v1/ai-variables (aiField) endpoint must be used instead.
Required scope:
AI_VARIABLES_WRITERate limit: 30 requests per minute
POST
/
v1
/
ai-variables
/
ai-messages
Create an ai message
curl --request POST \
--url https://openapi.enginy.ai/v1/ai-variables/ai-messages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"toneId": "<string>",
"model": "<string>",
"outputLength": 5,
"prompt": "<string>",
"description": "<string>",
"splitMessages": true,
"folderId": 123,
"customPromptFieldValues": [
{
"customPromptFieldId": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://openapi.enginy.ai/v1/ai-variables/ai-messages"
payload = {
"name": "<string>",
"toneId": "<string>",
"model": "<string>",
"outputLength": 5,
"prompt": "<string>",
"description": "<string>",
"splitMessages": True,
"folderId": 123,
"customPromptFieldValues": [
{
"customPromptFieldId": "<string>",
"value": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
toneId: '<string>',
model: '<string>',
outputLength: 5,
prompt: '<string>',
description: '<string>',
splitMessages: true,
folderId: 123,
customPromptFieldValues: [{customPromptFieldId: '<string>', value: '<string>'}]
})
};
fetch('https://openapi.enginy.ai/v1/ai-variables/ai-messages', 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://openapi.enginy.ai/v1/ai-variables/ai-messages",
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' => '<string>',
'toneId' => '<string>',
'model' => '<string>',
'outputLength' => 5,
'prompt' => '<string>',
'description' => '<string>',
'splitMessages' => true,
'folderId' => 123,
'customPromptFieldValues' => [
[
'customPromptFieldId' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://openapi.enginy.ai/v1/ai-variables/ai-messages"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"toneId\": \"<string>\",\n \"model\": \"<string>\",\n \"outputLength\": 5,\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"splitMessages\": true,\n \"folderId\": 123,\n \"customPromptFieldValues\": [\n {\n \"customPromptFieldId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://openapi.enginy.ai/v1/ai-variables/ai-messages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"toneId\": \"<string>\",\n \"model\": \"<string>\",\n \"outputLength\": 5,\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"splitMessages\": true,\n \"folderId\": 123,\n \"customPromptFieldValues\": [\n {\n \"customPromptFieldId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.enginy.ai/v1/ai-variables/ai-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"toneId\": \"<string>\",\n \"model\": \"<string>\",\n \"outputLength\": 5,\n \"prompt\": \"<string>\",\n \"description\": \"<string>\",\n \"splitMessages\": true,\n \"folderId\": 123,\n \"customPromptFieldValues\": [\n {\n \"customPromptFieldId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {}
}Authorizations
Body
application/json
Minimum string length:
1Available options:
EMAIL, LINKEDIN, WHATSAPP, LINKEDIN_INMAIL, LINKEDIN_CONNECTION Minimum string length:
1Minimum string length:
1Required range:
0 <= x <= 10Plain prompt text. Placeholders: {fieldId} for contact/company/CRM/formula/notes fields (discover via the contact/company field-metadata endpoints), {aiResearch:<id-or-name>}, {aiSnippet:<id-or-name>}, {aiMessage:<id-or-name>} for AI entity references. Validation is strict: unknown or ambiguous tokens return 400 with the invalid tokens and a sample of valid ones. Escape literal braces by doubling them ({{ and }}).
Show child attributes
Show child attributes
⌘I