Execute Agent Operating Procedure

Deprecated

DEPRECATED: This endpoint is deprecated. Please use /aop/execute-async instead for better performance and reliability. 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.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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
final_promptstring
Final prompt used for execution including user inputs
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
conversationobject or null
The conversation result from the AOP execution
errorstring or null
Error message if execution failed

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error