Skip to main content

Execute agent with code

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

Executes an agent with the given code. The request body must be either a JSON array of key/value input parameters, or a JSON object following the chat completions format.

Request​

Path Parameters

    agentCode stringrequired

Query Parameters

    culture string

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

Body

array

  • Array [

    • Key stringrequired

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

    Value stringrequired

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

  • ]

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​

Success

Loading...