Create a new playground session

curl --request POST \
  --url http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Test Session 1",
  "metadata": {}
}
'

import requests

url = "http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions"

payload = {
    "name": "Test Session 1",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Test Session 1', metadata: {}})
};

fetch('http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "5173",
  CURLOPT_URL => "http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions",
  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([
    'name' => 'Test Session 1',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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 := "http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions"

	payload := strings.NewReader("{\n  \"name\": \"Test Session 1\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Test Session 1\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Test Session 1\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Test Session 1",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "executions": [
      {
        "id": "<string>",
        "startedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "metadata": {}
  },
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "name",
    "message": "Name is required"
  }
}

{
  "success": false,
  "error": "Resource not found",
  "code": "NOT_FOUND"
}

{
  "success": false,
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

POST

workflows

{id}

playground

sessions

Create a new playground session

curl --request POST \
  --url http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Test Session 1",
  "metadata": {}
}
'

import requests

url = "http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions"

payload = {
    "name": "Test Session 1",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Test Session 1', metadata: {}})
};

fetch('http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "5173",
  CURLOPT_URL => "http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions",
  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([
    'name' => 'Test Session 1',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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 := "http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions"

	payload := strings.NewReader("{\n  \"name\": \"Test Session 1\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Test Session 1\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/flowdrop/workflows/{id}/playground/sessions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Test Session 1\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Test Session 1",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "executions": [
      {
        "id": "<string>",
        "startedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "metadata": {}
  },
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "error": "Invalid request parameters",
  "code": "VALIDATION_ERROR",
  "details": {
    "field": "name",
    "message": "Name is required"
  }
}

{
  "success": false,
  "error": "Resource not found",
  "code": "NOT_FOUND"
}

{
  "success": false,
  "error": "Internal server error",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

JWT token for authentication

Path Parameters

string<uuid>

required

Workflow UUID

Body

application/json

name

string

Optional session name

Maximum string length: 100

Example:

"Test Session 1"

metadata

object

Optional metadata for the session

Response

Session created successfully

success

boolean

Whether the request was successful

data

object

A playground session represents an isolated test environment for a workflow. Sessions maintain conversation history and allow interactive testing.

Show child attributes

message

string

Response message

error

string

Error message (if any)

API documentation

Endpoints

Create a new playground session

Authorizations

Path Parameters

Body

Response