Execute code in a sandbox session
curl --request POST \
--url https://flowra.dev/api/v1/sandbox/sessions/{id}/execute \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"language": "javascript",
"source": "export default async function ({ state }) { return { ...state, ok: true }; }",
"state": {
"invoiceId": "inv_123"
},
"timeoutMs": 8000
}
'import requests
url = "https://flowra.dev/api/v1/sandbox/sessions/{id}/execute"
payload = {
"language": "javascript",
"source": "export default async function ({ state }) { return { ...state, ok: true }; }",
"state": { "invoiceId": "inv_123" },
"timeoutMs": 8000
}
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({
language: 'javascript',
source: 'export default async function ({ state }) { return { ...state, ok: true }; }',
state: {invoiceId: 'inv_123'},
timeoutMs: 8000
})
};
fetch('https://flowra.dev/api/v1/sandbox/sessions/{id}/execute', 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/sandbox/sessions/{id}/execute",
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([
'language' => 'javascript',
'source' => 'export default async function ({ state }) { return { ...state, ok: true }; }',
'state' => [
'invoiceId' => 'inv_123'
],
'timeoutMs' => 8000
]),
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/sandbox/sessions/{id}/execute"
payload := strings.NewReader("{\n \"language\": \"javascript\",\n \"source\": \"export default async function ({ state }) { return { ...state, ok: true }; }\",\n \"state\": {\n \"invoiceId\": \"inv_123\"\n },\n \"timeoutMs\": 8000\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/sandbox/sessions/{id}/execute")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"language\": \"javascript\",\n \"source\": \"export default async function ({ state }) { return { ...state, ok: true }; }\",\n \"state\": {\n \"invoiceId\": \"inv_123\"\n },\n \"timeoutMs\": 8000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/sandbox/sessions/{id}/execute")
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 \"language\": \"javascript\",\n \"source\": \"export default async function ({ state }) { return { ...state, ok: true }; }\",\n \"state\": {\n \"invoiceId\": \"inv_123\"\n },\n \"timeoutMs\": 8000\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "",
"status": "succeeded",
"language": "",
"result": {},
"error": "",
"durationMs": 0
}
}{
"id": "<string>",
"status": "succeeded",
"language": "<string>",
"result": {},
"error": "<string>",
"durationMs": 123
}Sandbox
Execute code in a sandbox session
Runs JavaScript or Python inside an existing live session. The session stays alive after the run.
POST
/
api
/
v1
/
sandbox
/
sessions
/
{id}
/
execute
Execute code in a sandbox session
curl --request POST \
--url https://flowra.dev/api/v1/sandbox/sessions/{id}/execute \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"language": "javascript",
"source": "export default async function ({ state }) { return { ...state, ok: true }; }",
"state": {
"invoiceId": "inv_123"
},
"timeoutMs": 8000
}
'import requests
url = "https://flowra.dev/api/v1/sandbox/sessions/{id}/execute"
payload = {
"language": "javascript",
"source": "export default async function ({ state }) { return { ...state, ok: true }; }",
"state": { "invoiceId": "inv_123" },
"timeoutMs": 8000
}
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({
language: 'javascript',
source: 'export default async function ({ state }) { return { ...state, ok: true }; }',
state: {invoiceId: 'inv_123'},
timeoutMs: 8000
})
};
fetch('https://flowra.dev/api/v1/sandbox/sessions/{id}/execute', 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/sandbox/sessions/{id}/execute",
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([
'language' => 'javascript',
'source' => 'export default async function ({ state }) { return { ...state, ok: true }; }',
'state' => [
'invoiceId' => 'inv_123'
],
'timeoutMs' => 8000
]),
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/sandbox/sessions/{id}/execute"
payload := strings.NewReader("{\n \"language\": \"javascript\",\n \"source\": \"export default async function ({ state }) { return { ...state, ok: true }; }\",\n \"state\": {\n \"invoiceId\": \"inv_123\"\n },\n \"timeoutMs\": 8000\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/sandbox/sessions/{id}/execute")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"language\": \"javascript\",\n \"source\": \"export default async function ({ state }) { return { ...state, ok: true }; }\",\n \"state\": {\n \"invoiceId\": \"inv_123\"\n },\n \"timeoutMs\": 8000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/sandbox/sessions/{id}/execute")
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 \"language\": \"javascript\",\n \"source\": \"export default async function ({ state }) { return { ...state, ok: true }; }\",\n \"state\": {\n \"invoiceId\": \"inv_123\"\n },\n \"timeoutMs\": 8000\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "",
"status": "succeeded",
"language": "",
"result": {},
"error": "",
"durationMs": 0
}
}{
"id": "<string>",
"status": "succeeded",
"language": "<string>",
"result": {},
"error": "<string>",
"durationMs": 123
}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
Body
application/json
Script language
Available options:
javascript, python Example:
"javascript"
Script source (JavaScript or Python)
Example:
"export default async function ({ state }) { return { ...state, ok: true }; }"
State object passed to the script (default preview state if omitted)
Example:
{ "invoiceId": "inv_123" }
Timeout in milliseconds (default 8000, max 20000)
Required range:
1000 <= x <= 20000Example:
8000
Response
Session execute result
Was this page helpful?