Execute agent with code.

POST /api/v2/agent/:agentCode/execute

Executes an agent with the given code.

Request

agentCode stringrequired

culture string

Use this param to override the culture of the response. Options: - en (default) - es

array

Key stringrequired

The key of the parameter (e.g., chatId, message)

Value stringrequired

The corresponding value (e.g., conversationId, message)

You can append Volatile Knowledge files to your execute request by adding the following key/value pair to the body of your request:

[ 
  {
    "Key": "volatileKnowledgeIds",
    "Value": ["volatileKnowledgeId1", "volatileKnowledgeId2"]
  }
]  

Use the Upload endpoint to get the volatileKnowledgeId of your files.

Success

There was a validation error. Please check your request data.

Schema

message stringnullable

errors

object

nullable

property name* string

{
  "message": "string",
  "errors": {}
}