Skip to main content

Execute agent version with code

POST 

/api/v2/Agent/:agentCode/execute/:agentVersion

Executes an agent version with the given code.

Request

Path Parameters

    agentCode stringrequired
    agentVersion int32required

Query Parameters

    culture string

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

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 volatileKnowledgeId of 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 fileId of your audio file.

Responses

OK

Loading...