API ReferenceAop

Execute Agent Operating Procedure

Beta

Execute an existing Agent Operating Procedure (AOP) asset with optional user inputs. AOPs are pre-configured AI workflows that can perform complex tasks like research, analysis, and content generation.

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
asset_idstringRequired
ID of the existing AOP asset to execute
user_inputsmap from strings to strings or nullOptional

Optional user inputs to append to the AOP’s prompt as key-value pairs

Response

AOP execution started successfully
aop_asset_idstring
ID of the AOP asset that was executed
aop_configmap from strings to any
Full configuration of the AOP asset
aop_titlestring
Title of the AOP asset
base_promptstring
Base prompt of the AOP before user inputs were added
enabled_toolslist of strings or null
List of tools that were enabled for this execution
final_promptstring
Final prompt used for execution including user inputs
responsemap from strings to any
The execution response from the AOP
statusstring

Status of the execution (e.g., ‘submitted’)

sync_serverstring
Sync server URL used for execution
thread_idstring
Unique thread ID for tracking the execution
trigger_typestring
Type of trigger that initiated the execution

Errors