Variables
Create variable
POST
/
public
/
api
/
v1
/
agents
/
{agentPublicId}
/
prompt
/
variables
Create variable
curl --request POST \
--url https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"booleanTextWhenFalse": "no",
"booleanTextWhenTrue": "yes",
"defaultValue": "Ada",
"description": "Full name of the customer being assisted.",
"label": "Customer name",
"multiChoiceSeparator": ", ",
"name": "customer_name",
"options": [
{
"injectedText": "the customer is on the Pro plan",
"label": "Pro plan",
"sortOrder": 1
}
],
"required": true,
"sortOrder": 10
}
'import requests
url = "https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables"
payload = {
"booleanTextWhenFalse": "no",
"booleanTextWhenTrue": "yes",
"defaultValue": "Ada",
"description": "Full name of the customer being assisted.",
"label": "Customer name",
"multiChoiceSeparator": ", ",
"name": "customer_name",
"options": [
{
"injectedText": "the customer is on the Pro plan",
"label": "Pro plan",
"sortOrder": 1
}
],
"required": True,
"sortOrder": 10
}
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({
booleanTextWhenFalse: 'no',
booleanTextWhenTrue: 'yes',
defaultValue: 'Ada',
description: 'Full name of the customer being assisted.',
label: 'Customer name',
multiChoiceSeparator: ', ',
name: 'customer_name',
options: [
{
injectedText: 'the customer is on the Pro plan',
label: 'Pro plan',
sortOrder: 1
}
],
required: true,
sortOrder: 10
})
};
fetch('https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables', 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://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables",
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([
'booleanTextWhenFalse' => 'no',
'booleanTextWhenTrue' => 'yes',
'defaultValue' => 'Ada',
'description' => 'Full name of the customer being assisted.',
'label' => 'Customer name',
'multiChoiceSeparator' => ', ',
'name' => 'customer_name',
'options' => [
[
'injectedText' => 'the customer is on the Pro plan',
'label' => 'Pro plan',
'sortOrder' => 1
]
],
'required' => true,
'sortOrder' => 10
]),
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://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables"
payload := strings.NewReader("{\n \"booleanTextWhenFalse\": \"no\",\n \"booleanTextWhenTrue\": \"yes\",\n \"defaultValue\": \"Ada\",\n \"description\": \"Full name of the customer being assisted.\",\n \"label\": \"Customer name\",\n \"multiChoiceSeparator\": \", \",\n \"name\": \"customer_name\",\n \"options\": [\n {\n \"injectedText\": \"the customer is on the Pro plan\",\n \"label\": \"Pro plan\",\n \"sortOrder\": 1\n }\n ],\n \"required\": true,\n \"sortOrder\": 10\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://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"booleanTextWhenFalse\": \"no\",\n \"booleanTextWhenTrue\": \"yes\",\n \"defaultValue\": \"Ada\",\n \"description\": \"Full name of the customer being assisted.\",\n \"label\": \"Customer name\",\n \"multiChoiceSeparator\": \", \",\n \"name\": \"customer_name\",\n \"options\": [\n {\n \"injectedText\": \"the customer is on the Pro plan\",\n \"label\": \"Pro plan\",\n \"sortOrder\": 1\n }\n ],\n \"required\": true,\n \"sortOrder\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables")
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 \"booleanTextWhenFalse\": \"no\",\n \"booleanTextWhenTrue\": \"yes\",\n \"defaultValue\": \"Ada\",\n \"description\": \"Full name of the customer being assisted.\",\n \"label\": \"Customer name\",\n \"multiChoiceSeparator\": \", \",\n \"name\": \"customer_name\",\n \"options\": [\n {\n \"injectedText\": \"the customer is on the Pro plan\",\n \"label\": \"Pro plan\",\n \"sortOrder\": 1\n }\n ],\n \"required\": true,\n \"sortOrder\": 10\n}"
response = http.request(request)
puts response.read_body{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}Autorizações
Parâmetros de caminho
Corpo
application/json
Body for creating a new dynamic prompt variable on an agent.
Type of the variable, controlling shape and validation of values.
Opções disponíveis:
text_short, text_long, number, date, time, datetime, single_choice, multi_choice, bool Text to inject when a boolean variable resolves to false.
Exemplo:
"no"
Text to inject when a boolean variable resolves to true.
Exemplo:
"yes"
Default value. Polymorphic: shape depends on type (string, number, boolean, choice).
Exemplo:
"Ada"
Optional help text shown next to the variable.
Maximum string length:
500Exemplo:
"Full name of the customer being assisted."
Human-readable label shown in the prompt editor.
Maximum string length:
200Exemplo:
"Customer name"
Separator used when concatenating multi_choice options into a single string.
Maximum string length:
10Exemplo:
", "
Stable identifier of the variable. Lowercase ASCII; must start with a letter and may contain digits and underscores. Up to 50 characters.
Minimum string length:
1Pattern:
^[a-z][a-z0-9_]{0,49}$Exemplo:
"customer_name"
Required (and validated 1..50) for single_choice / multi_choice variables.
Show child attributes
Show child attributes
Whether the variable must be set before the agent can respond.
Exemplo:
true
Sort order of this variable in the prompt editor.
Exemplo:
10
Resposta
Created
Dynamic-prompt variable definition (per agent).
Prompt fragment when bool variable is false.
Prompt fragment when bool variable is true.
Default value (shape depends on type).
Display label shown in the Hub form.
Joiner for multi_choice rendered values (default ,).
Slug used in {{name}} references inside the systemPrompt.
Options for single_choice / multi_choice (null otherwise).
Show child attributes
Show child attributes
Whether the Hub form must submit this field.
Opções disponíveis:
text_short, text_long, number, date, time, datetime, single_choice, multi_choice, bool Esta página foi útil?
Anterior
Delete variable (remove from prompt or purge)`mode=remove_from_prompt` (default) removes `{{name}}` from the system prompt and leaves the variable + per-installation values intact. `mode=purge` is irreversible: soft-deletes the variable and cascades to all hub-client values. Purge requires body `{"confirmation":"EXCLUIR"}`.
Próximo
⌘I
Create variable
curl --request POST \
--url https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"booleanTextWhenFalse": "no",
"booleanTextWhenTrue": "yes",
"defaultValue": "Ada",
"description": "Full name of the customer being assisted.",
"label": "Customer name",
"multiChoiceSeparator": ", ",
"name": "customer_name",
"options": [
{
"injectedText": "the customer is on the Pro plan",
"label": "Pro plan",
"sortOrder": 1
}
],
"required": true,
"sortOrder": 10
}
'import requests
url = "https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables"
payload = {
"booleanTextWhenFalse": "no",
"booleanTextWhenTrue": "yes",
"defaultValue": "Ada",
"description": "Full name of the customer being assisted.",
"label": "Customer name",
"multiChoiceSeparator": ", ",
"name": "customer_name",
"options": [
{
"injectedText": "the customer is on the Pro plan",
"label": "Pro plan",
"sortOrder": 1
}
],
"required": True,
"sortOrder": 10
}
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({
booleanTextWhenFalse: 'no',
booleanTextWhenTrue: 'yes',
defaultValue: 'Ada',
description: 'Full name of the customer being assisted.',
label: 'Customer name',
multiChoiceSeparator: ', ',
name: 'customer_name',
options: [
{
injectedText: 'the customer is on the Pro plan',
label: 'Pro plan',
sortOrder: 1
}
],
required: true,
sortOrder: 10
})
};
fetch('https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables', 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://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables",
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([
'booleanTextWhenFalse' => 'no',
'booleanTextWhenTrue' => 'yes',
'defaultValue' => 'Ada',
'description' => 'Full name of the customer being assisted.',
'label' => 'Customer name',
'multiChoiceSeparator' => ', ',
'name' => 'customer_name',
'options' => [
[
'injectedText' => 'the customer is on the Pro plan',
'label' => 'Pro plan',
'sortOrder' => 1
]
],
'required' => true,
'sortOrder' => 10
]),
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://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables"
payload := strings.NewReader("{\n \"booleanTextWhenFalse\": \"no\",\n \"booleanTextWhenTrue\": \"yes\",\n \"defaultValue\": \"Ada\",\n \"description\": \"Full name of the customer being assisted.\",\n \"label\": \"Customer name\",\n \"multiChoiceSeparator\": \", \",\n \"name\": \"customer_name\",\n \"options\": [\n {\n \"injectedText\": \"the customer is on the Pro plan\",\n \"label\": \"Pro plan\",\n \"sortOrder\": 1\n }\n ],\n \"required\": true,\n \"sortOrder\": 10\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://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"booleanTextWhenFalse\": \"no\",\n \"booleanTextWhenTrue\": \"yes\",\n \"defaultValue\": \"Ada\",\n \"description\": \"Full name of the customer being assisted.\",\n \"label\": \"Customer name\",\n \"multiChoiceSeparator\": \", \",\n \"name\": \"customer_name\",\n \"options\": [\n {\n \"injectedText\": \"the customer is on the Pro plan\",\n \"label\": \"Pro plan\",\n \"sortOrder\": 1\n }\n ],\n \"required\": true,\n \"sortOrder\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables")
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 \"booleanTextWhenFalse\": \"no\",\n \"booleanTextWhenTrue\": \"yes\",\n \"defaultValue\": \"Ada\",\n \"description\": \"Full name of the customer being assisted.\",\n \"label\": \"Customer name\",\n \"multiChoiceSeparator\": \", \",\n \"name\": \"customer_name\",\n \"options\": [\n {\n \"injectedText\": \"the customer is on the Pro plan\",\n \"label\": \"Pro plan\",\n \"sortOrder\": 1\n }\n ],\n \"required\": true,\n \"sortOrder\": 10\n}"
response = http.request(request)
puts response.read_body{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}{
"booleanTextWhenFalse": "<string>",
"booleanTextWhenTrue": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultValue": {},
"description": "<string>",
"label": "<string>",
"multiChoiceSeparator": "<string>",
"name": "<string>",
"options": [
{
"injectedText": "<string>",
"label": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 123
}
],
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": true,
"sortOrder": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}