List playground sessions for a workflow
Retrieve all playground sessions associated with a workflow. Sessions are used to test and interact with workflows in an isolated environment.
JWT token for authentication
In: header
Path Parameters
Workflow UUID
uuidQuery Parameters
Maximum number of sessions to return
1 <= value <= 10020Number of sessions to skip
0 <= value0Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/playground/sessions"{ "success": true, "message": "string", "error": "string", "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4", "name": "Test Session 1", "status": "idle", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "executions": [ { "id": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "running" } ], "metadata": {} } ]}Get messages from a playground session GET
Retrieve messages from a playground session with optional filtering. Supports polling via the `since` parameter to fetch only new messages.
Send a message to the playground session POST
Send a user message or trigger workflow execution with inputs. This starts or continues the conversation in the playground. The message is created with status "pending" and processing begins immediately (synchronously) or is queued (asynchronously) based on the session's execution mode. The response returns immediately with the message entity, allowing clients to poll the message status endpoint to track processing progress. Messages are processed in sequence order within a session to ensure proper conversation flow. If a previous message is not yet complete, the request will be rejected with a conflict error.