POST
/
tool-call
/
{tool}
/
{method}
curl --request POST \
  --url https://veyraxapp.com/tool-call/gmail/sendEmail \
  --header 'VEYRAX_API_KEY: <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "to": "recipient@example.com",
    "subject": "Hello from VeyraX",
    "body": "This is a test email sent via the VeyraX API."
  }'

{
  "messageId": "1234567890",
  "threadId": "0987654321",
  "status": "sent"
}

This endpoint executes a specific method of a tool with the provided parameters. The response format depends on the specific tool and method being called.

​
Path Parameters

​
tool
string
required

The name of the tool to call (e.g., “gmail”, “google-calendar”, “slack”)

​
method
string
required

The method of the tool to call (e.g., “listEmails”, “sendEmail”, “listEvents”)

​
Request Body

The request body should contain the parameters required by the specific tool method being called. The structure varies depending on the tool and method.

​
Response

The response format depends on the specific tool and method being called. Refer to the tool’s documentation for details on the expected response format.

​
Error Codes

​
404
object

Returned when the specified tool or method is not found.

​
500
object

Returned when there is a server error.

curl --request POST \
  --url https://veyraxapp.com/tool-call/gmail/sendEmail \
  --header 'VEYRAX_API_KEY: <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "to": "recipient@example.com",
    "subject": "Hello from VeyraX",
    "body": "This is a test email sent via the VeyraX API."
  }'

{
  "messageId": "1234567890",
  "threadId": "0987654321",
  "status": "sent"
}
Get Tools