v1

latestOpenAPI 3.0.22026-07-144526.3 KB

Execute App Action Endpoint

Give us a plain english description of exact action you want to do. There should be dynamically generated documentation for this endpoint for each action that is exposed.

post/api/v1/exposed/{exposed_app_action_id}/execute/

Path parameters

exposed_app_action_idstring required

Request body

instructionsstring required

Plain english instructions. Provide as much detail as possible.

preview_onlyboolean

If true, we will not execute the action, but will return the params of the preview.

Response

action_usedstring required

The name of the action that was executed.

errorstring

The error message if the execution failed.

idstring required

The id of the execution log.

input_paramsobject required

The params we used / will use to execute the action.

resultobject

A trimmed down result of the first item of the full results. Ideal for humans and language models!

review_urlstring required

The URL to run the action or review the AI choices the AI made for input_params given instructions.

status'success' | 'error' | 'empty' | 'preview'

The status of the execution.