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 '
{
  "resource_type": "workflow",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource_type": "workflow",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
Creates a new chat session for a workflow or other resource.

​
Usage

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

​
Request Body

{
  "resource_type": "workflow",
  "resource_id": "0199e001-a23b-7c8d-1234-567890abcdef",
  "title": "My Workflow Chat"
}

​
Response

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

​
Resource Types

  • workflow - Chat with a workflow
  • gui - Chat from desktop/GUI application
  • api - Chat via API integration

​
Use Cases

  • Start conversations - Create new chat sessions
  • Desktop app - Initialize chat on app launch
  • Web app - Create chats from workflow builder

​
Notes

Authentication required: Chat will be associated with the authenticated user

Authorizations

​
Authorization
string
header
required

JWT token from Splox account

Body

application/json
​
resource_type
enum<string>
required

Type of resource

Available options:
workflow,
gui,
api
​
resource_id
string<uuid>
required

ID of the resource

​
title
string

Chat title

Response

201 - application/json

Chat created successfully

​
id
string<uuid>
​
user_id
string<uuid>
​
resource_type
enum<string>
Available options:
workflow,
gui,
api
​
resource_id
string<uuid>
​
title
string
​
created_at
string<date-time>
​
updated_at
string<date-time>