API Referencev1Actions

Get single action

Get action details, including the input and response schema. This is very useful for setting upfunction/tool calling with composio actions.

Path parameters

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

Headers

x-api-keystringRequired

Query parameters

versionstringOptional

Response

parametersobject

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.

responseobject
Expected response structure after action execution. You can use this to quickly check what happened with the action execution.
appKeystring
The name of the app that the action belongs to. This is same as appId.
appNamestring
The name of the app that the action belongs to,
versionstring
Version of the action schema.
available_versionslist of objects
List of availavle versions of the action.
no_authboolean
Whether or not the action requires auth or not
descriptionstring

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

displayNamestring
The display name of the action, used to identify the action in the UI.
namestring
The name of the action, used to identify the action in the UI.
tagslist of strings
The tags of the action, used to categorize the action in the UI.
appIdstringDeprecated
The id of the app that the action belongs to. This is same as the appKey. Please use appKey instead.
deprecatedboolean or null
Whether the action is deprecated, if true, avoid using this action.