Skip to main content
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": {}
}
'
{
  "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>"
}

Authorizations

​
Authorization
string
header
required

JWT token for authentication

Path Parameters

​
id
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.

​
message
string

Response message

​
error
string

Error message (if any)