Skip to main content
POST
/
api
/
agent
/
branding
Retrieve branding information for your institution (Digital Twin)
curl --request POST \
  --url http://localhost:3000/api/agent/branding \
  --header 'Content-Type: application/json' \
  --data '
{
  "publicId": "5f03e5e6-9dde-4ddc-b686-7a77ac617e52"
}
'
{
  "picture": "https://pria.praxislxp.com/logo192_v3.webp",
  "picture_animated": "",
  "picture_bg": "https://pria.praxislxp.com/pria_bg2.webp",
  "about": "I am an AI-powered virtual mentor programmed to help experts, students, faculty, and researchers with their digital corporate, education, research, and career goals...",
  "ainame": "Pria",
  "status": "active"
}

Body

application/json
​
publicId
string
required

The public identifier for the agent

Example:

"5f03e5e6-9dde-4ddc-b686-7a77ac617e52"

Response

200 - application/json

Successfully retrieved agent branding information

​
picture
string

URL to the agent's profile picture

Example:

"https://pria.praxislxp.com/logo192_v3.webp"

​
picture_animated
string

URL to the agent's animated picture (if available)

Example:

""

​
picture_bg
string

URL to the agent's background picture

Example:

"https://pria.praxislxp.com/pria_bg2.webp"

​
about
string

Description of the AI agent's (digital twin a.k.a. instance) purpose and capabilities

Example:

"I am an AI-powered virtual mentor programmed to help experts, students, faculty, and researchers with their digital corporate, education, research, and career goals..."

​
ainame
string

Name of the AI agent

Example:

"Pria"

​
status
string

Current status of the agent

Example:

"active"