API ReferenceAop

Execute Agent Operating Procedure Asynchronously

Beta

Start execution of an Agent Operating Procedure (AOP) asset asynchronously. Returns immediately with a thread_id for tracking execution progress without waiting for completion.

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
messagestring
Status message about the async execution
statusstring

Status of the execution (always ‘started’ for async)

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