Execute an action

API key for authentication, you can easily get it from the dashboard after login or if you are using CLI, you can get it from the composio whoami command

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.

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

(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

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.

Used internally by our SDK's to keep track of the source of execution, ignore it.

Custom authentication credentials to use while executing an action.

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

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

The system prompt to be used by LLM, use this to control and guide the behaviour of the LLM.

The response data returned by the action execution.

Whether the action execution was successfully executed or not. If this is false, error field will be populated with the error message.

Whether the action execution was successfully executed or not. If this is false, error field will be populated with the error message.

The error message, if the action failed to execute. If the action is successful, this will be null.