Execute tool
curl --request POST \
--url https://flowra.dev/api/v1/tools/execute/{toolSlug} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connectedAccountId": "account_123",
"mcpServerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"metaSessionId": "meta_sess_01HZX",
"version": "2.0.0",
"customAuthParams": {
"baseUrl": "https://api.example.com",
"parameters": [
{
"name": "Authorization",
"in": "header",
"value": "Bearer token123"
}
],
"body": {}
},
"arguments": {
"channel": "#general",
"text": "Hello from Flowra"
},
"text": "Send a message to the #general channel",
"allowTracing": false,
"proxyUrl": "http://127.0.0.1:7890",
"invokeViaMcp": false,
"preferOwnerConnectionBinds": false
}
'import requests
url = "https://flowra.dev/api/v1/tools/execute/{toolSlug}"
payload = {
"connectedAccountId": "account_123",
"mcpServerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"metaSessionId": "meta_sess_01HZX",
"version": "2.0.0",
"customAuthParams": {
"baseUrl": "https://api.example.com",
"parameters": [
{
"name": "Authorization",
"in": "header",
"value": "Bearer token123"
}
],
"body": {}
},
"arguments": {
"channel": "#general",
"text": "Hello from Flowra"
},
"text": "Send a message to the #general channel",
"allowTracing": False,
"proxyUrl": "http://127.0.0.1:7890",
"invokeViaMcp": False,
"preferOwnerConnectionBinds": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectedAccountId: 'account_123',
mcpServerId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
metaSessionId: 'meta_sess_01HZX',
version: '2.0.0',
customAuthParams: {
baseUrl: 'https://api.example.com',
parameters: [{name: 'Authorization', in: 'header', value: 'Bearer token123'}],
body: JSON.stringify({})
},
arguments: {channel: '#general', text: 'Hello from Flowra'},
text: 'Send a message to the #general channel',
allowTracing: false,
proxyUrl: 'http://127.0.0.1:7890',
invokeViaMcp: false,
preferOwnerConnectionBinds: false
})
};
fetch('https://flowra.dev/api/v1/tools/execute/{toolSlug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/tools/execute/{toolSlug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectedAccountId' => 'account_123',
'mcpServerId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'metaSessionId' => 'meta_sess_01HZX',
'version' => '2.0.0',
'customAuthParams' => [
'baseUrl' => 'https://api.example.com',
'parameters' => [
[
'name' => 'Authorization',
'in' => 'header',
'value' => 'Bearer token123'
]
],
'body' => [
]
],
'arguments' => [
'channel' => '#general',
'text' => 'Hello from Flowra'
],
'text' => 'Send a message to the #general channel',
'allowTracing' => false,
'proxyUrl' => 'http://127.0.0.1:7890',
'invokeViaMcp' => false,
'preferOwnerConnectionBinds' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/tools/execute/{toolSlug}"
payload := strings.NewReader("{\n \"connectedAccountId\": \"account_123\",\n \"mcpServerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"metaSessionId\": \"meta_sess_01HZX\",\n \"version\": \"2.0.0\",\n \"customAuthParams\": {\n \"baseUrl\": \"https://api.example.com\",\n \"parameters\": [\n {\n \"name\": \"Authorization\",\n \"in\": \"header\",\n \"value\": \"Bearer token123\"\n }\n ],\n \"body\": {}\n },\n \"arguments\": {\n \"channel\": \"#general\",\n \"text\": \"Hello from Flowra\"\n },\n \"text\": \"Send a message to the #general channel\",\n \"allowTracing\": false,\n \"proxyUrl\": \"http://127.0.0.1:7890\",\n \"invokeViaMcp\": false,\n \"preferOwnerConnectionBinds\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://flowra.dev/api/v1/tools/execute/{toolSlug}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connectedAccountId\": \"account_123\",\n \"mcpServerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"metaSessionId\": \"meta_sess_01HZX\",\n \"version\": \"2.0.0\",\n \"customAuthParams\": {\n \"baseUrl\": \"https://api.example.com\",\n \"parameters\": [\n {\n \"name\": \"Authorization\",\n \"in\": \"header\",\n \"value\": \"Bearer token123\"\n }\n ],\n \"body\": {}\n },\n \"arguments\": {\n \"channel\": \"#general\",\n \"text\": \"Hello from Flowra\"\n },\n \"text\": \"Send a message to the #general channel\",\n \"allowTracing\": false,\n \"proxyUrl\": \"http://127.0.0.1:7890\",\n \"invokeViaMcp\": false,\n \"preferOwnerConnectionBinds\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/tools/execute/{toolSlug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectedAccountId\": \"account_123\",\n \"mcpServerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"metaSessionId\": \"meta_sess_01HZX\",\n \"version\": \"2.0.0\",\n \"customAuthParams\": {\n \"baseUrl\": \"https://api.example.com\",\n \"parameters\": [\n {\n \"name\": \"Authorization\",\n \"in\": \"header\",\n \"value\": \"Bearer token123\"\n }\n ],\n \"body\": {}\n },\n \"arguments\": {\n \"channel\": \"#general\",\n \"text\": \"Hello from Flowra\"\n },\n \"text\": \"Send a message to the #general channel\",\n \"allowTracing\": false,\n \"proxyUrl\": \"http://127.0.0.1:7890\",\n \"invokeViaMcp\": false,\n \"preferOwnerConnectionBinds\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"data": {},
"error": "Invalid credentials",
"successful": true,
"sessionInfo": {},
"logId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}{
"data": {},
"error": "Invalid credentials",
"successful": true,
"sessionInfo": {},
"logId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}Tools
Execute tool
Run a tool by its slug with the arguments you provide. Use this when building agents or automation that need to call tools (e.g. send email, call an API).
POST
/
api
/
v1
/
tools
/
execute
/
{toolSlug}
Execute tool
curl --request POST \
--url https://flowra.dev/api/v1/tools/execute/{toolSlug} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connectedAccountId": "account_123",
"mcpServerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"metaSessionId": "meta_sess_01HZX",
"version": "2.0.0",
"customAuthParams": {
"baseUrl": "https://api.example.com",
"parameters": [
{
"name": "Authorization",
"in": "header",
"value": "Bearer token123"
}
],
"body": {}
},
"arguments": {
"channel": "#general",
"text": "Hello from Flowra"
},
"text": "Send a message to the #general channel",
"allowTracing": false,
"proxyUrl": "http://127.0.0.1:7890",
"invokeViaMcp": false,
"preferOwnerConnectionBinds": false
}
'import requests
url = "https://flowra.dev/api/v1/tools/execute/{toolSlug}"
payload = {
"connectedAccountId": "account_123",
"mcpServerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"metaSessionId": "meta_sess_01HZX",
"version": "2.0.0",
"customAuthParams": {
"baseUrl": "https://api.example.com",
"parameters": [
{
"name": "Authorization",
"in": "header",
"value": "Bearer token123"
}
],
"body": {}
},
"arguments": {
"channel": "#general",
"text": "Hello from Flowra"
},
"text": "Send a message to the #general channel",
"allowTracing": False,
"proxyUrl": "http://127.0.0.1:7890",
"invokeViaMcp": False,
"preferOwnerConnectionBinds": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectedAccountId: 'account_123',
mcpServerId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
metaSessionId: 'meta_sess_01HZX',
version: '2.0.0',
customAuthParams: {
baseUrl: 'https://api.example.com',
parameters: [{name: 'Authorization', in: 'header', value: 'Bearer token123'}],
body: JSON.stringify({})
},
arguments: {channel: '#general', text: 'Hello from Flowra'},
text: 'Send a message to the #general channel',
allowTracing: false,
proxyUrl: 'http://127.0.0.1:7890',
invokeViaMcp: false,
preferOwnerConnectionBinds: false
})
};
fetch('https://flowra.dev/api/v1/tools/execute/{toolSlug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/tools/execute/{toolSlug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectedAccountId' => 'account_123',
'mcpServerId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'metaSessionId' => 'meta_sess_01HZX',
'version' => '2.0.0',
'customAuthParams' => [
'baseUrl' => 'https://api.example.com',
'parameters' => [
[
'name' => 'Authorization',
'in' => 'header',
'value' => 'Bearer token123'
]
],
'body' => [
]
],
'arguments' => [
'channel' => '#general',
'text' => 'Hello from Flowra'
],
'text' => 'Send a message to the #general channel',
'allowTracing' => false,
'proxyUrl' => 'http://127.0.0.1:7890',
'invokeViaMcp' => false,
'preferOwnerConnectionBinds' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/tools/execute/{toolSlug}"
payload := strings.NewReader("{\n \"connectedAccountId\": \"account_123\",\n \"mcpServerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"metaSessionId\": \"meta_sess_01HZX\",\n \"version\": \"2.0.0\",\n \"customAuthParams\": {\n \"baseUrl\": \"https://api.example.com\",\n \"parameters\": [\n {\n \"name\": \"Authorization\",\n \"in\": \"header\",\n \"value\": \"Bearer token123\"\n }\n ],\n \"body\": {}\n },\n \"arguments\": {\n \"channel\": \"#general\",\n \"text\": \"Hello from Flowra\"\n },\n \"text\": \"Send a message to the #general channel\",\n \"allowTracing\": false,\n \"proxyUrl\": \"http://127.0.0.1:7890\",\n \"invokeViaMcp\": false,\n \"preferOwnerConnectionBinds\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://flowra.dev/api/v1/tools/execute/{toolSlug}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connectedAccountId\": \"account_123\",\n \"mcpServerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"metaSessionId\": \"meta_sess_01HZX\",\n \"version\": \"2.0.0\",\n \"customAuthParams\": {\n \"baseUrl\": \"https://api.example.com\",\n \"parameters\": [\n {\n \"name\": \"Authorization\",\n \"in\": \"header\",\n \"value\": \"Bearer token123\"\n }\n ],\n \"body\": {}\n },\n \"arguments\": {\n \"channel\": \"#general\",\n \"text\": \"Hello from Flowra\"\n },\n \"text\": \"Send a message to the #general channel\",\n \"allowTracing\": false,\n \"proxyUrl\": \"http://127.0.0.1:7890\",\n \"invokeViaMcp\": false,\n \"preferOwnerConnectionBinds\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/tools/execute/{toolSlug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectedAccountId\": \"account_123\",\n \"mcpServerId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"metaSessionId\": \"meta_sess_01HZX\",\n \"version\": \"2.0.0\",\n \"customAuthParams\": {\n \"baseUrl\": \"https://api.example.com\",\n \"parameters\": [\n {\n \"name\": \"Authorization\",\n \"in\": \"header\",\n \"value\": \"Bearer token123\"\n }\n ],\n \"body\": {}\n },\n \"arguments\": {\n \"channel\": \"#general\",\n \"text\": \"Hello from Flowra\"\n },\n \"text\": \"Send a message to the #general channel\",\n \"allowTracing\": false,\n \"proxyUrl\": \"http://127.0.0.1:7890\",\n \"invokeViaMcp\": false,\n \"preferOwnerConnectionBinds\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"data": {},
"error": "Invalid credentials",
"successful": true,
"sessionInfo": {},
"logId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}{
"data": {},
"error": "Invalid credentials",
"successful": true,
"sessionInfo": {},
"logId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}Authorizations
x-api-keyx-api-key & x-username
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Headers
External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.
Path Parameters
Tool slug from DISCOVER / GET /tools (e.g. gmail_send_email)
Example:
"gmail_send_email"
Body
application/json
Connected account ID
Example:
"account_123"
MCP server owner id (toolsMode / discovery / pins)
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Ephemeral meta session id from DISCOVER_TOOLS
Example:
"meta_sess_01HZX"
Tool version
Example:
"2.0.0"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Tool arguments matching the tool’s input JSON Schema
Example:
{
"channel": "#general",
"text": "Hello from Flowra"
}
Natural language description of what to accomplish
Example:
"Send a message to the #general channel"
Allow tracing for debugging
Example:
false
One-off outbound proxy for this execution only (http(s) or socks). Not persisted in outbound_proxies. Takes precedence over the server default proxy and over proxyUrl on connection val.
Example:
"http://127.0.0.1:7890"
Internal: MCP invocation flag
Internal: prefer owner connection binds
Response
Tool executed successfully
Success status
Example:
true
Success message
Example:
"Operation completed successfully"
Show child attributes
Show child attributes
Example:
{
"data": {},
"error": "Invalid credentials",
"successful": true,
"sessionInfo": {},
"logId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
Was this page helpful?