API Referencev1Actions

Execute an action

Execute an action. Support both connected account and no auth auth.

Path parameters

actionIdstringRequiredformat: "[^\/#\?]+?"

Headers

x-api-keystringRequired

Request

ActionExecutionReqDTO
connectedAccountIdstringOptionalformat: "uuid"

Connected account uuid for the account you want to run the action on. You can get this from the id field in /api/v1/connectedAccounts endpoint.

appNamestringOptional

The name/id of the app that the action belongs to. To get the app name, you can use the /api/v1/apps endpoint.

entityIdstringOptional

(Optional) EntityId that represents your users connections - if the required connection is availabe for the user, it’ll be auto-picked. If you are passing this, there’s no need to pass connectedAccountId. To know more about entityId, click here

inputobjectOptional

Action inputs or aguments to execute the action. This is a dict/map with key-value structure, depdning on the action schema you can find in /api/v2/actions/{actionName} endpoint.

sessionInfoobjectOptional
Used internally by our SDK's to keep track of the source of execution, ignore it.
authConfigobjectOptional
Custom authentication credentials to use while executing an action.
textstringOptional

The use-case description for the action, this will give context to LLM to generate the correct inputs for the action.

customDescriptionstringOptional

The custom description for the action, use this to provide customised context about the action to the LLM to suit your use-case.

systemPromptstringOptional
The system prompt to be used by LLM, use this to control and guide the behaviour of the LLM.
versionstringOptional
Version of the action you want to execute.
traceLogslist of objectsOptional
allowTracingbooleanOptionalDefaults to false
If true, session Info and log ID will be included in the response for tracing purposes.

Response

dataobject
The response data returned by the action execution.
successfulboolean
Whether the action execution was successfully executed or not. If this is false, error field will be populated with the error message.
successfullbooleanDeprecated
Whether the action execution was successfully executed or not. If this is false, error field will be populated with the error message.
errorstring or null
The error message, if the action failed to execute. If the action is successful, this will be null.
logIdstring or null
The id of the log request.
sessionInfoobject or null
The session info of the action execution.