Saltar para o conteúdo principal
GET
/
public
/
api
/
v1
/
agents
/
{agentPublicId}
Get agent
curl --request GET \
  --url https://api.gennia.ai/public/api/v1/agents/{agentPublicId} \
  --header 'X-Api-Key: <api-key>'
{
  "aiModelName": "<string>",
  "aiModelPublicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audioListeningEnabled": true,
  "audioResponseEnabled": true,
  "avatarUrl": "<string>",
  "categories": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "draftVersionNumber": 123,
  "dynamicPromptEnabled": true,
  "followUpAfterHours": 123,
  "followUpBusinessHoursEnd": "14:30:00",
  "followUpBusinessHoursStart": "14:30:00",
  "followUpEnabled": true,
  "followUpInactivityMinutes": 123,
  "followUpIntervalMinutes": 123,
  "followUpMaxAttempts": 123,
  "followUpPrompt": "<string>",
  "genuiEnabled": true,
  "hasExternalChannel": true,
  "hasUnpublishedChanges": true,
  "longTermMemoryEnabled": true,
  "memoryCustomInstructions": "<string>",
  "messageDelayEnabled": true,
  "messageSplittingEnabled": true,
  "name": "<string>",
  "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "publishedVersionNumber": 123,
  "sandboxEnabled": true,
  "systemPrompt": "<string>",
  "temperature": 123,
  "thinkingEnabled": true,
  "ttsVoice": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "webSearchEnabled": true
}

Autorizações

​
X-Api-Key
string
header
obrigatório

Parâmetros de caminho

​
agentPublicId
string<uuid>
obrigatório

Agent public ID

Resposta

OK

Agent metadata + editable-state configuration.

​
aiModelName
string

Selected AI model display name; null when not yet configured.

​
aiModelPublicId
string<uuid>

Selected AI model public ID; null when not yet configured.

​
audioListeningEnabled
boolean
​
audioResponseEnabled
boolean
​
avatarUrl
string
​
categories
string[]
​
createdAt
string<date-time>
​
description
string
​
draftVersionNumber
integer<int32>
​
dynamicPromptEnabled
boolean
​
followUpAfterHours
integer<int32>
​
followUpBusinessHoursEnd
string
Exemplo:

"14:30:00"

​
followUpBusinessHoursStart
string
Exemplo:

"14:30:00"

​
followUpEnabled
boolean
​
followUpInactivityMinutes
integer<int32>
​
followUpIntervalMinutes
integer<int32>
​
followUpMaxAttempts
integer<int32>
​
followUpPrompt
string
​
genuiEnabled
boolean
​
hasExternalChannel
boolean
​
hasUnpublishedChanges
boolean

True if the editable state differs from the published snapshot.

​
longTermMemoryEnabled
boolean
​
memoryCustomInstructions
string
​
messageDelayEnabled
boolean
​
messageDelayType
enum<string>

Delay tier when messageDelayEnabled=true.

Opções disponíveis:
LOW,
MEDIUM,
HIGH,
RANDOM
​
messageSplittingEnabled
boolean
​
name
string
​
publicId
string<uuid>
​
publishedVersionNumber
integer<int32>
​
sandboxEnabled
boolean
​
status
enum<string>
Opções disponíveis:
draft,
active,
inactive,
archived
​
systemPrompt
string
​
temperature
number<float>
​
thinkingEffort
enum<string>

Thinking effort tier.

Opções disponíveis:
low,
medium,
high
​
thinkingEnabled
boolean
​
ttsVoice
string
​
updatedAt
string<date-time>
​
webSearchEnabled
boolean