API ReferenceV1Actions

Execute with HTTP Client

Use composio as a http client to make request to the connected account service on your behalf, without managing authentication on your side.

Headers

x-api-keystringRequired

Request

ActionProxyRequestConfigDTO

endpointstringRequired

The endpoint to call for the action. If the given url is relative, it will be resolved relative to the base_url set in the connected account info.

methodenumRequired

The HTTP method to use for the action.

Allowed values:
parameterslist of objectsRequired
connectedAccountIdstringOptional

The connected account uuid to use for the action.

bodyobjectOptional

The body to be sent to the endpoint. This can either be a JSON field or a string.

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.

errorstringOptional

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

logIdstringOptional

The id of the log request.

sessionInfoobjectOptional

The session info of the action execution.