Execute an action

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

Authorizations

x-api-key

string

header

required

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

Path Parameters

actionId

string

required

Body

application/json

appName

string

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

authConfig

object

Custom authentication credentials to use while executing an action.

Show child attributes

authConfig.parameters

object[]

required

Show child attributes

authConfig.parameters.in

enum<string>

required

The location of the parameter. Can be 'query' or 'header'.

Available options:

query,

header

authConfig.parameters.name

string

required

The name of the parameter. For example, 'x-api-key', 'Content-Type', etc.

authConfig.parameters.value

string

required

The value of the parameter. For example, '1234567890', 'application/json', etc.

authConfig.base_url

string

The base URL (root address) what you should use while making http requests to the connected account. For example, for gmail, it would be 'https://gmail.googleapis.com'

authConfig.body

object

The body to be sent to the endpoint for authentication. This can either be a JSON field or a string. Note: This is very rarely neeed and is only required by very few apps.

connectedAccountId

string

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.

customDescription

string

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

entityId

string

(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

input

object

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.

sessionInfo

object

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

Show child attributes

sessionInfo.metadata

object

sessionInfo.sessionId

string

systemPrompt

string

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

text

string

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

Response

200 - application/json

data

object

required

The response data returned by the action execution.

successful

boolean

required

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

successfull

boolean

requireddeprecated

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

error

string

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