GET
/
api
/
v2
/
actions
/
{actionId}

Authorizations

x-api-key
string
headerrequired

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

Response

200 - application/json
parameters
object
required

Required parameters for the action to execute. For example, if the action is GMAIL_SEND_EMAIL, the required parameters for actions execution would be the email address, subject, and body.

response
object
required

Expected response structure after action execution. You can use this to quickly check what happened with the action execution.

appKey
string
required

The name of the app that the action belongs to. This is same as appId.

appName
string
required

The name of the app that the action belongs to,

appId
string
requireddeprecated

The id of the app that the action belongs to. This is same as the appKey. Please use appKey instead.

description
string
required

The description of the action, tailored to improve the LLM accuracy and reasoning. Use this a tool/function description.

displayName
string
required

The display name of the action, used to identify the action in the UI.

The logo of the app that the action belongs to.

name
string
required

The name of the action, used to identify the action in the UI.

tags
string[]
required

The tags of the action, used to categorize the action in the UI.

deprecated
boolean

Whether the action is deprecated, if true, avoid using this action.