Execute agent version with code
POST/api/v2/Agent/:agentCode/execute/:agentVersion
Executes an agent version with the given code.
Request
Path Parameters
Query Parameters
Use this param to override the culture of the response. Options: - en (default) - es
- application/json
- text/json
- application/*+json
Body
any
Body
any
Body
any
Volatile Knowledge
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
volatileKnowledgeIdof your files.
Audio Transcription
You can pass an audio file for transcription in your execute request by adding the following key/value pair to the body of your request:
[
{
"Key": "audioInput",
"Value": {
"fileId": "[your audio file ID]",
}
}
]
Use the Upload File endpoint to get the
fileIdof your audio file.
Responses
- 200
- 400
- 401
- 403
- 500
OK
There was a validation error. Please check your request data.
- application/json
- Schema
- Example (from schema)
Schema
errors
object
nullable
{
"message": "string",
"errors": {}
}
The user is unauthorized or the session expired
The user does not have permission
There was an unexpected error