Updates an existing activity agent
PUT/api/v2/agent/activity/:agentCode
Updates an existing activity agent
Request
Path Parameters
The code of the system agent to update.
Query Parameters
Use this param to override the culture of the response. Options: - en (default) - es
- application/json
- text/json
- application/*+json
Body
The system agent update request containing details.
Array [
]
Array [
- AgentExecutorSkillReq
- CodeExecutionSkillReq
- EmailSkillReq
- HttpRequestSkillReq
- ImageGenerationSkillReq
- PromptSkillReq
- RemoteMcpSkillReq
- SkillReq
- SpeechGenerationSkillReq
- WebSearchSkillReq
- WorkflowExecutorSkillReq
Array [
]
- ApiKeyAuthReq
- BasicAuthReq
- BearerTokenAuthReq
- CookiesAuthReq
Array [
Array [
]
]
Array [
]
- ApiKeyAuthReq
- BasicAuthReq
- BearerTokenAuthReq
- CookiesAuthReq
Array [
Array [
]
]
]
general
object
required
Possible values: non-empty and <= 64 characters
Possible values: <= 2000 characters
instructions
object
required
Possible values: non-empty and <= 40000 characters
Possible values: <= 4000 characters
model
object
required
main
object
knowledge
object
knowledgeSources
object[]
nullable
List of files to be integrated
metadata
object
Possible values: <= 1000 characters
Possible values: <= 1021 characters
List of dataset ids to be integrated as knowledge sources
advancedSettings
object
The mode of knowledge integration, which determines how the knowledge is integrated into the agent's context. If not provided, default values will be set
The model used to generate the embeddings IF changed, all files will be reprocessed.
Possible values: <= 1
The relevance score of the knowledge If not provided, default values will be set
Possible values: >= 1 and <= 100
Sets a limit on the number of sections to retrieve If not provided, default values will be set
skills
object[]
nullable
List of skills to be added to the agent.
oneOf
Request model for creating or updating an Agent Executor skill within an agent.
Possible values: non-empty, [AgentExecutor]
The skill type identifier. Always "AgentExecutor" for agent executor skills.
settings
object
required
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9\-]*$
The code of the agent to execute when this skill is invoked.
The version of the agent to use for this skill.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Code Execution skill within an agent.
Possible values: non-empty, [CodeExecution]
The skill type identifier. Always "CodeExecution" for code execution skills.
settings
object
Configuration options for the code execution skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an Email skill within an agent.
Possible values: non-empty, [Email]
The skill type identifier. Always "Email" for email skills.
settings
object
required
Configuration options for the email skill.
List of email recipients.
Email subject. May include Liquid template placeholders.
Email body content. May include HTML and Liquid template placeholders.
customSmtpConfiguration
object
Custom SMTP server configuration for sending emails.
Possible values: non-empty
The display name of the sender.
Possible values: non-empty
The email address of the sender.
Possible values: non-empty
The SMTP server address.
The username for SMTP authentication.
The password for SMTP authentication.
Possible values: >= 1 and <= 65535
The SMTP server port.
Whether to use TLS/SSL for secure connection.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an HTTP Request skill within an agent.
Possible values: non-empty, [HttpRequest]
The skill type identifier. Always "HttpRequest" for HTTP request skills.
settings
object
required
Configuration settings for the HTTP request skill.
Possible values: non-empty
The HTTP method to use for the request (e.g., "GET", "POST", "PUT", "DELETE").
url
object
required
Represents a URL configuration with dynamic parameters.
Possible values: non-empty
The URL value, which may contain Liquid template placeholders (e.g., "https://api.example.com/v1/{{ resource }}").
parameters
object[]
nullable
The parameters that can be used within the URL template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
auth
object
nullable
Authentication configuration for the HTTP request.
oneOf
API Key authentication configuration.
Possible values: non-empty
The header name where the API key should be included (e.g., "X-Api-Key").
Possible values: non-empty
The API key value.
Basic authentication configuration.
Possible values: non-empty
The username for basic authentication.
Possible values: non-empty
The password for basic authentication.
Bearer Token authentication configuration.
Possible values: non-empty
The bearer token value.
Cookies-based authentication configuration.
headers
object[]
nullable
Optional headers to include in the HTTP request.
Possible values: non-empty
The header key (e.g., "Content-Type", "Authorization").
Possible values: non-empty
The header value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the header value template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
body
object
Represents the body configuration for an HTTP request.
Possible values: non-empty, [Legacy, None, Static, AIGenerated, Dynamic]
The body type (e.g., "Legacy", "None", "Static", "AIGenerated", "Dynamic").
Possible values: non-empty
The body value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the body template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
When true, response headers will be included in the skill result.
When true, Set-Cookie headers will be enabled in the response.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an Image Generation skill within an agent.
Possible values: non-empty, [ImageGenerator]
The skill type identifier. Always "ImageGenerator" for image generation skills.
settings
object
Configuration options for the image generation skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Prompt skill within an agent.
Possible values: non-empty, [Prompt]
The skill type identifier. Always "Prompt" for prompt-based skills.
settings
object
required
Configuration options for the prompt skill.
Possible values: <= 40000 characters
The prompt template to be used for this skill. This can include placeholders for input parameters.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Remote MCP skill within an agent.
Possible values: non-empty, [RemoteMcp]
The skill type identifier. Always "RemoteMcp" for remote MCP skills.
settings
object
required
Configuration settings for the Remote MCP skill.
Possible values: non-empty
The server URL for the Remote MCP endpoint.
auth
object
nullable
Authentication configuration for the HTTP request.
oneOf
API Key authentication configuration.
Possible values: non-empty
The header name where the API key should be included (e.g., "X-Api-Key").
Possible values: non-empty
The API key value.
Basic authentication configuration.
Possible values: non-empty
The username for basic authentication.
Possible values: non-empty
The password for basic authentication.
Bearer Token authentication configuration.
Possible values: non-empty
The bearer token value.
Cookies-based authentication configuration.
headers
object[]
nullable
Optional headers to include in the HTTP request.
Possible values: non-empty
The header key (e.g., "Content-Type", "Authorization").
Possible values: non-empty
The header value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the header value template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a skill within an agent.
Possible values: non-empty, [ChartGeneration, CheckCondition, ConversationContext, ConversationRetriever, ConversationSummary, JsonMerge, Math, Text, Time, Wait, WebFileDownload, WorkbenchMcp]
The plugin identifier (e.g., "ChartGeneration", "Math").
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Speech Generation skill within an agent.
Possible values: non-empty, [SpeechGeneration]
The skill type identifier. Always "SpeechGeneration" for speech generation skills.
settings
object
Configuration options for the speech generation skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Web Search skill within an agent.
Possible values: non-empty, [WebSearch]
The skill type identifier. Always "WebSearch" for web search skills.
settings
object
Configuration options for the web search skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Workflow Executor skill within an agent.
Possible values: non-empty, [WorkflowExecutor]
The skill type identifier. Always "WorkflowExecutor" for workflow executor skills.
settings
object
required
Configuration options for the workflow executor skill.
The unique identifier of the workflow definition to execute.
Possible values: non-empty
The version identifier of the workflow to execute.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Body
The system agent update request containing details.
Array [
]
Array [
- AgentExecutorSkillReq
- CodeExecutionSkillReq
- EmailSkillReq
- HttpRequestSkillReq
- ImageGenerationSkillReq
- PromptSkillReq
- RemoteMcpSkillReq
- SkillReq
- SpeechGenerationSkillReq
- WebSearchSkillReq
- WorkflowExecutorSkillReq
Array [
]
- ApiKeyAuthReq
- BasicAuthReq
- BearerTokenAuthReq
- CookiesAuthReq
Array [
Array [
]
]
Array [
]
- ApiKeyAuthReq
- BasicAuthReq
- BearerTokenAuthReq
- CookiesAuthReq
Array [
Array [
]
]
]
general
object
required
Possible values: non-empty and <= 64 characters
Possible values: <= 2000 characters
instructions
object
required
Possible values: non-empty and <= 40000 characters
Possible values: <= 4000 characters
model
object
required
main
object
knowledge
object
knowledgeSources
object[]
nullable
List of files to be integrated
metadata
object
Possible values: <= 1000 characters
Possible values: <= 1021 characters
List of dataset ids to be integrated as knowledge sources
advancedSettings
object
The mode of knowledge integration, which determines how the knowledge is integrated into the agent's context. If not provided, default values will be set
The model used to generate the embeddings IF changed, all files will be reprocessed.
Possible values: <= 1
The relevance score of the knowledge If not provided, default values will be set
Possible values: >= 1 and <= 100
Sets a limit on the number of sections to retrieve If not provided, default values will be set
skills
object[]
nullable
List of skills to be added to the agent.
oneOf
Request model for creating or updating an Agent Executor skill within an agent.
Possible values: non-empty, [AgentExecutor]
The skill type identifier. Always "AgentExecutor" for agent executor skills.
settings
object
required
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9\-]*$
The code of the agent to execute when this skill is invoked.
The version of the agent to use for this skill.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Code Execution skill within an agent.
Possible values: non-empty, [CodeExecution]
The skill type identifier. Always "CodeExecution" for code execution skills.
settings
object
Configuration options for the code execution skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an Email skill within an agent.
Possible values: non-empty, [Email]
The skill type identifier. Always "Email" for email skills.
settings
object
required
Configuration options for the email skill.
List of email recipients.
Email subject. May include Liquid template placeholders.
Email body content. May include HTML and Liquid template placeholders.
customSmtpConfiguration
object
Custom SMTP server configuration for sending emails.
Possible values: non-empty
The display name of the sender.
Possible values: non-empty
The email address of the sender.
Possible values: non-empty
The SMTP server address.
The username for SMTP authentication.
The password for SMTP authentication.
Possible values: >= 1 and <= 65535
The SMTP server port.
Whether to use TLS/SSL for secure connection.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an HTTP Request skill within an agent.
Possible values: non-empty, [HttpRequest]
The skill type identifier. Always "HttpRequest" for HTTP request skills.
settings
object
required
Configuration settings for the HTTP request skill.
Possible values: non-empty
The HTTP method to use for the request (e.g., "GET", "POST", "PUT", "DELETE").
url
object
required
Represents a URL configuration with dynamic parameters.
Possible values: non-empty
The URL value, which may contain Liquid template placeholders (e.g., "https://api.example.com/v1/{{ resource }}").
parameters
object[]
nullable
The parameters that can be used within the URL template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
auth
object
nullable
Authentication configuration for the HTTP request.
oneOf
API Key authentication configuration.
Possible values: non-empty
The header name where the API key should be included (e.g., "X-Api-Key").
Possible values: non-empty
The API key value.
Basic authentication configuration.
Possible values: non-empty
The username for basic authentication.
Possible values: non-empty
The password for basic authentication.
Bearer Token authentication configuration.
Possible values: non-empty
The bearer token value.
Cookies-based authentication configuration.
headers
object[]
nullable
Optional headers to include in the HTTP request.
Possible values: non-empty
The header key (e.g., "Content-Type", "Authorization").
Possible values: non-empty
The header value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the header value template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
body
object
Represents the body configuration for an HTTP request.
Possible values: non-empty, [Legacy, None, Static, AIGenerated, Dynamic]
The body type (e.g., "Legacy", "None", "Static", "AIGenerated", "Dynamic").
Possible values: non-empty
The body value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the body template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
When true, response headers will be included in the skill result.
When true, Set-Cookie headers will be enabled in the response.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an Image Generation skill within an agent.
Possible values: non-empty, [ImageGenerator]
The skill type identifier. Always "ImageGenerator" for image generation skills.
settings
object
Configuration options for the image generation skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Prompt skill within an agent.
Possible values: non-empty, [Prompt]
The skill type identifier. Always "Prompt" for prompt-based skills.
settings
object
required
Configuration options for the prompt skill.
Possible values: <= 40000 characters
The prompt template to be used for this skill. This can include placeholders for input parameters.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Remote MCP skill within an agent.
Possible values: non-empty, [RemoteMcp]
The skill type identifier. Always "RemoteMcp" for remote MCP skills.
settings
object
required
Configuration settings for the Remote MCP skill.
Possible values: non-empty
The server URL for the Remote MCP endpoint.
auth
object
nullable
Authentication configuration for the HTTP request.
oneOf
API Key authentication configuration.
Possible values: non-empty
The header name where the API key should be included (e.g., "X-Api-Key").
Possible values: non-empty
The API key value.
Basic authentication configuration.
Possible values: non-empty
The username for basic authentication.
Possible values: non-empty
The password for basic authentication.
Bearer Token authentication configuration.
Possible values: non-empty
The bearer token value.
Cookies-based authentication configuration.
headers
object[]
nullable
Optional headers to include in the HTTP request.
Possible values: non-empty
The header key (e.g., "Content-Type", "Authorization").
Possible values: non-empty
The header value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the header value template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a skill within an agent.
Possible values: non-empty, [ChartGeneration, CheckCondition, ConversationContext, ConversationRetriever, ConversationSummary, JsonMerge, Math, Text, Time, Wait, WebFileDownload, WorkbenchMcp]
The plugin identifier (e.g., "ChartGeneration", "Math").
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Speech Generation skill within an agent.
Possible values: non-empty, [SpeechGeneration]
The skill type identifier. Always "SpeechGeneration" for speech generation skills.
settings
object
Configuration options for the speech generation skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Web Search skill within an agent.
Possible values: non-empty, [WebSearch]
The skill type identifier. Always "WebSearch" for web search skills.
settings
object
Configuration options for the web search skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Workflow Executor skill within an agent.
Possible values: non-empty, [WorkflowExecutor]
The skill type identifier. Always "WorkflowExecutor" for workflow executor skills.
settings
object
required
Configuration options for the workflow executor skill.
The unique identifier of the workflow definition to execute.
Possible values: non-empty
The version identifier of the workflow to execute.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Body
The system agent update request containing details.
Array [
]
Array [
- AgentExecutorSkillReq
- CodeExecutionSkillReq
- EmailSkillReq
- HttpRequestSkillReq
- ImageGenerationSkillReq
- PromptSkillReq
- RemoteMcpSkillReq
- SkillReq
- SpeechGenerationSkillReq
- WebSearchSkillReq
- WorkflowExecutorSkillReq
Array [
]
- ApiKeyAuthReq
- BasicAuthReq
- BearerTokenAuthReq
- CookiesAuthReq
Array [
Array [
]
]
Array [
]
- ApiKeyAuthReq
- BasicAuthReq
- BearerTokenAuthReq
- CookiesAuthReq
Array [
Array [
]
]
]
general
object
required
Possible values: non-empty and <= 64 characters
Possible values: <= 2000 characters
instructions
object
required
Possible values: non-empty and <= 40000 characters
Possible values: <= 4000 characters
model
object
required
main
object
knowledge
object
knowledgeSources
object[]
nullable
List of files to be integrated
metadata
object
Possible values: <= 1000 characters
Possible values: <= 1021 characters
List of dataset ids to be integrated as knowledge sources
advancedSettings
object
The mode of knowledge integration, which determines how the knowledge is integrated into the agent's context. If not provided, default values will be set
The model used to generate the embeddings IF changed, all files will be reprocessed.
Possible values: <= 1
The relevance score of the knowledge If not provided, default values will be set
Possible values: >= 1 and <= 100
Sets a limit on the number of sections to retrieve If not provided, default values will be set
skills
object[]
nullable
List of skills to be added to the agent.
oneOf
Request model for creating or updating an Agent Executor skill within an agent.
Possible values: non-empty, [AgentExecutor]
The skill type identifier. Always "AgentExecutor" for agent executor skills.
settings
object
required
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9\-]*$
The code of the agent to execute when this skill is invoked.
The version of the agent to use for this skill.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Code Execution skill within an agent.
Possible values: non-empty, [CodeExecution]
The skill type identifier. Always "CodeExecution" for code execution skills.
settings
object
Configuration options for the code execution skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an Email skill within an agent.
Possible values: non-empty, [Email]
The skill type identifier. Always "Email" for email skills.
settings
object
required
Configuration options for the email skill.
List of email recipients.
Email subject. May include Liquid template placeholders.
Email body content. May include HTML and Liquid template placeholders.
customSmtpConfiguration
object
Custom SMTP server configuration for sending emails.
Possible values: non-empty
The display name of the sender.
Possible values: non-empty
The email address of the sender.
Possible values: non-empty
The SMTP server address.
The username for SMTP authentication.
The password for SMTP authentication.
Possible values: >= 1 and <= 65535
The SMTP server port.
Whether to use TLS/SSL for secure connection.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an HTTP Request skill within an agent.
Possible values: non-empty, [HttpRequest]
The skill type identifier. Always "HttpRequest" for HTTP request skills.
settings
object
required
Configuration settings for the HTTP request skill.
Possible values: non-empty
The HTTP method to use for the request (e.g., "GET", "POST", "PUT", "DELETE").
url
object
required
Represents a URL configuration with dynamic parameters.
Possible values: non-empty
The URL value, which may contain Liquid template placeholders (e.g., "https://api.example.com/v1/{{ resource }}").
parameters
object[]
nullable
The parameters that can be used within the URL template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
auth
object
nullable
Authentication configuration for the HTTP request.
oneOf
API Key authentication configuration.
Possible values: non-empty
The header name where the API key should be included (e.g., "X-Api-Key").
Possible values: non-empty
The API key value.
Basic authentication configuration.
Possible values: non-empty
The username for basic authentication.
Possible values: non-empty
The password for basic authentication.
Bearer Token authentication configuration.
Possible values: non-empty
The bearer token value.
Cookies-based authentication configuration.
headers
object[]
nullable
Optional headers to include in the HTTP request.
Possible values: non-empty
The header key (e.g., "Content-Type", "Authorization").
Possible values: non-empty
The header value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the header value template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
body
object
Represents the body configuration for an HTTP request.
Possible values: non-empty, [Legacy, None, Static, AIGenerated, Dynamic]
The body type (e.g., "Legacy", "None", "Static", "AIGenerated", "Dynamic").
Possible values: non-empty
The body value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the body template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
When true, response headers will be included in the skill result.
When true, Set-Cookie headers will be enabled in the response.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating an Image Generation skill within an agent.
Possible values: non-empty, [ImageGenerator]
The skill type identifier. Always "ImageGenerator" for image generation skills.
settings
object
Configuration options for the image generation skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Prompt skill within an agent.
Possible values: non-empty, [Prompt]
The skill type identifier. Always "Prompt" for prompt-based skills.
settings
object
required
Configuration options for the prompt skill.
Possible values: <= 40000 characters
The prompt template to be used for this skill. This can include placeholders for input parameters.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Remote MCP skill within an agent.
Possible values: non-empty, [RemoteMcp]
The skill type identifier. Always "RemoteMcp" for remote MCP skills.
settings
object
required
Configuration settings for the Remote MCP skill.
Possible values: non-empty
The server URL for the Remote MCP endpoint.
auth
object
nullable
Authentication configuration for the HTTP request.
oneOf
API Key authentication configuration.
Possible values: non-empty
The header name where the API key should be included (e.g., "X-Api-Key").
Possible values: non-empty
The API key value.
Basic authentication configuration.
Possible values: non-empty
The username for basic authentication.
Possible values: non-empty
The password for basic authentication.
Bearer Token authentication configuration.
Possible values: non-empty
The bearer token value.
Cookies-based authentication configuration.
headers
object[]
nullable
Optional headers to include in the HTTP request.
Possible values: non-empty
The header key (e.g., "Content-Type", "Authorization").
Possible values: non-empty
The header value, which may contain Liquid template placeholders.
parameters
object[]
nullable
The parameters that can be used within the header value template.
Possible values: non-empty
The parameter name.
Possible values: non-empty
The parameter description that explains its purpose.
Whether the variable is considered required (rather than optional).
The default value for the input variable.
JSON Schema describing this variable.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a skill within an agent.
Possible values: non-empty, [ChartGeneration, CheckCondition, ConversationContext, ConversationRetriever, ConversationSummary, JsonMerge, Math, Text, Time, Wait, WebFileDownload, WorkbenchMcp]
The plugin identifier (e.g., "ChartGeneration", "Math").
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Speech Generation skill within an agent.
Possible values: non-empty, [SpeechGeneration]
The skill type identifier. Always "SpeechGeneration" for speech generation skills.
settings
object
Configuration options for the speech generation skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Web Search skill within an agent.
Possible values: non-empty, [WebSearch]
The skill type identifier. Always "WebSearch" for web search skills.
settings
object
Configuration options for the web search skill.
Possible values: non-empty
The model code associated with this skill.
Possible values: non-empty
The vendor providing the model or service.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Request model for creating or updating a Workflow Executor skill within an agent.
Possible values: non-empty, [WorkflowExecutor]
The skill type identifier. Always "WorkflowExecutor" for workflow executor skills.
settings
object
required
Configuration options for the workflow executor skill.
The unique identifier of the workflow definition to execute.
Possible values: non-empty
The version identifier of the workflow to execute.
Possible values: <= 50 characters, Value must match regular expression ^[a-zA-Z0-9]+$
The unique code for this skill configuration.
Possible values: <= 4000 characters
The description of this skill configuration.
When set to true, the skill result will be returned within the agent result.
When set to true, the skill results will be cached and reused throughout a conversation as long as the input parameters remain the same.
Only active skills will be imported during agent execution.
Responses
- 200
- 400
- 401
- 403
- 500
System agent updated successfully.
If the request is invalid or business validation fails.
The user is unauthorized or the session expired
The user does not have permission
There was an unexpected error