Variables
Update variable
PATCH
/
public
/
api
/
v1
/
agents
/
{agentPublicId}
/
prompt
/
variables
/
{variablePublicId}
Update variable
curl --request PATCH \
--url https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables/{variablePublicId} \
--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/{variablePublicId}"
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.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
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/{variablePublicId}', 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/{variablePublicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
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/{variablePublicId}"
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("PATCH", 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.patch("https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables/{variablePublicId}")
.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/{variablePublicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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"
}Autorizações
Corpo
application/json
Body for updating an existing dynamic prompt variable. All fields are optional; only provided fields are updated. JsonNullable fields are tri-state: omit, set, or clear with null.
New text to inject when a boolean variable resolves to false.
Show child attributes
Show child attributes
Exemplo:
"no"
New text to inject when a boolean variable resolves to true.
Show child attributes
Show child attributes
Exemplo:
"yes"
New default value. Polymorphic: shape depends on the variable's type.
Show child attributes
Show child attributes
Exemplo:
"Ada"
New help text shown next to the variable.
Show child attributes
Show child attributes
Exemplo:
"Full name of the customer being assisted."
New human-readable label.
Maximum string length:
200Exemplo:
"Customer name"
New separator used when concatenating multi_choice options into a single string.
Show child attributes
Show child attributes
Exemplo:
", "
New stable identifier of the variable. Same naming rules as on create.
Pattern:
^[a-z][a-z0-9_]{0,49}$Exemplo:
"customer_name"
When provided, replaces the option set entirely.
Show child attributes
Show child attributes
Whether the variable must be set before the agent can respond.
Exemplo:
true
New sort order of this variable in the prompt editor.
Exemplo:
10
New variable type. Changing type may require resetting defaultValue/options.
Opções disponíveis:
text_short, text_long, number, date, time, datetime, single_choice, multi_choice, bool Resposta
OK
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?
⌘I
Update variable
curl --request PATCH \
--url https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables/{variablePublicId} \
--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/{variablePublicId}"
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.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
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/{variablePublicId}', 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/{variablePublicId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
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/{variablePublicId}"
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("PATCH", 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.patch("https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables/{variablePublicId}")
.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/{variablePublicId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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"
}