Saltar para o conteúdo principal
GET
/
public
/
api
/
v1
/
agents
/
{agentPublicId}
/
prompt
/
variables
List variables
curl --request GET \
  --url https://api.gennia.ai/public/api/v1/agents/{agentPublicId}/prompt/variables \
  --header 'X-Api-Key: <api-key>'
[
  {
    "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

​
X-Api-Key
string
header
obrigatório

Parâmetros de caminho

​
agentPublicId
string<uuid>
obrigatório

Parâmetros de consulta

​
includeOrphaned
boolean
padrão:true

Include variables defined but no longer referenced in the editable systemPrompt.

Resposta

OK

​
booleanTextWhenFalse
string

Prompt fragment when bool variable is false.

​
booleanTextWhenTrue
string

Prompt fragment when bool variable is true.

​
createdAt
string<date-time>
​
defaultValue
object

Default value (shape depends on type).

​
description
string
​
label
string

Display label shown in the Hub form.

​
multiChoiceSeparator
string

Joiner for multi_choice rendered values (default ,).

​
name
string

Slug used in {{name}} references inside the systemPrompt.

​
options
object[]

Options for single_choice / multi_choice (null otherwise).

​
publicId
string<uuid>
​
required
boolean

Whether the Hub form must submit this field.

​
sortOrder
integer<int32>
​
type
enum<string>
Opções disponíveis:
text_short,
text_long,
number,
date,
time,
datetime,
single_choice,
multi_choice,
bool
​
updatedAt
string<date-time>