Skip to main content
POST
/
chats
Create Chat
curl --request POST \
  --url https://app.splox.io/api/v1/chats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support Chat",
  "resource_type": "api",
  "resource_id": "0199e001-a23b-7c8d-1234-567890abcdef"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_id": "<string>",
  "is_public": true,
  "public_share_token": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
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

curl -X POST https://app.splox.io/api/v1/chats \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Chat Session",
    "resource_type": "api",
    "resource_id": "0199e001-a23b-7c8d-1234-567890abcdef"
  }'

​
Request Body

FieldTypeRequiredDescription
namestringYesDisplay name for the chat session
resource_typestringYesMust be api
resource_idstringYesID of the resource (workflow ID, agent ID, etc.)
metadataobjectNoOptional metadata

​
Response

{
  "id": "0199f200-a11b-7c8d-4444-888890abcdef",
  "name": "My Chat Session",
  "user_id": "0199d001-c45d-9e0f-3456-789012cdef01",
  "resource_type": "workflow",
  "resource_id": "0199e001-a23b-7c8d-1234-567890abcdef",
  "is_public": false,
  "created_at": "2025-10-22T10:00:00Z",
  "updated_at": "2025-10-22T10:00:00Z"
}

​
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
​
created_at
string<date-time>
​
updated_at
string<date-time>