Skip to main content
PATCH
/
api
/
v2
/
appuid
/
{appUid}
/
agents
/
uid
/
{agentUid}
/
dynamicComponents
/
name
/
{name}
Update a dynamic component
curl --request PATCH \
  --url https://a.api.mindset.ai/api/v2/appuid/{appUid}/agents/uid/{agentUid}/dynamicComponents/name/{name} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "enabled": true,
  "instructions": "<string>"
}
'
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "enabled": true,
  "instructions": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
appUid
string
required

Your application's uid

Minimum string length: 1
​
agentUid
string
required

The agent's uid

Minimum string length: 1
​
name
string
required

The component name (e.g., 'mindset-accordion')

Minimum string length: 1

Body

application/json

Fields that can be updated on a dynamic component

​
enabled
boolean

Whether the component is enabled for use by the AI agent

​
instructions
string

Custom instructions for the AI agent on when and how to use this component

Required string length: 1 - 2000

Response

Successful update

​
name
string
read-only

Unique name/identifier of the component (e.g., 'mindset-accordion')

​
title
string
read-only

Display title of the component

​
description
string
read-only

Description of what the component does

​
enabled
boolean
default:true

Whether the component is enabled for use by the AI agent

​
instructions
string

Custom instructions for the AI agent on when and how to use this component

Required string length: 1 - 2000
​
createdAt
string<date-time>
read-only

Creation timestamp (ISO 8601)

​
modifiedAt
string<date-time>
read-only

Last modification timestamp (ISO 8601)