Skip to main content
POST
Create Chat
Creates a new chat session. A chat is required before running a workflow via the API — the chat ID is passed to POST /workflow-requests/run.

Usage

Request Body

Response

Notes

Authentication required: The chat is automatically associated with the authenticated user.

Authorizations

Authorization
string
header
required

API token generated from your Splox account settings. Create tokens at https://app.splox.io/account?tab=settings

Body

application/json
name
string
required

Display name for the chat session

resource_type
enum<string>
required

Type of resource this chat is associated with

Available options:
api
resource_id
string
required

ID of the resource (workflow ID, agent ID, etc.)

metadata
object

Optional metadata for the chat

Response

201 - application/json

Chat created successfully

id
string<uuid>
name
string
user_id
string<uuid>
resource_type
enum<string>
Available options:
api,
workflow,
agent,
gui
resource_id
string
is_public
boolean
public_share_token
string | null
metadata
object | null
created_at
string<date-time>
updated_at
string<date-time>