Skip to main content
GET
/
api
/
v1
/
appuid
/
{appUid}
/
agents
/
uid
/
{uid}
Retrieve an agent by UID
curl --request GET \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/agents/uid/{uid} \
  --header 'x-api-key: <api-key>'
{
  "uid": "<string>",
  "agentName": "<string>",
  "agentPurpose": "<string>",
  "formatting": "<string>",
  "agentPersonality": "<string>",
  "agentPolicyRules": "<string>",
  "live": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "contextUids": [
    "<string>"
  ],
  "mcpserverUids": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "access": "openAccess"
}

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum length: 1
uid
string
required

Unique ID of the agent

Response

Successful retrieval

uid
string

Unique ID of the agent

agentName
string

Name of the agent

agentPurpose
string

Purpose of the agent

formatting
string

Output formatting instructions

agentPersonality
string

Personality of the agent

agentPolicyRules
string

Policy rules for the agent

live
boolean
default:false

Activate the agent and make it live for end users

createdAt
string<date-time>

Creation timestamp (ISO 8601)

contextUids
string[]

Array of existing context Uids (max 30)

Maximum length: 30
mcpserverUids
string[]

Array of existing MCP server Uids (max 5)

Maximum length: 5
tags
string[]

Array of tags (max 10)

Maximum length: 10
access
enum<string>
Available options:
openAccess,
restrictedAccess
I