Create a new chat session

Creates a new chat session for the authenticated user. The session ID should be used in subsequent send-message requests via the x-session-id header.

POST /chat-sessions/create

Create a new chat session

cURL

curl --request POST \
  --url https://api.flipsidecrypto.xyz/public/v3/chat-sessions/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "meta": "<unknown>",
  "version": "5",
  "userAgent": "web"
}
'

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "meta": null,
  "isPublic": false,
  "visibility": "personal",
  "version": "4",
  "userAgent": "web"
}

Authorizations

x-api-key · string · header · required

Body

application/json

meta · any | null

Optional metadata for the chat session

version · string · default: 5

Chat session version

userAgent · enum<string> | null

Source attribution (web, cli, api, slack, etc.)

Available options: web, cli, internal-cli, api, slack, discord, telegram, schedule, unknown, null

Response

201

application/json

Chat session created successfully

id · string · required

Chat session ID (may be UUID or legacy string format)

Example:

"123e4567-e89b-12d3-a456-426614174000"

userId · string · required

createdAt · string<date-time> · required

organizationId · string<uuid> · required

createdById · string<uuid> · required

updatedById · string<uuid> · required

meta · unknown

isPublic · boolean · default: false

visibility · enum<string> · default: personal

Available options: personal, organization, public

version · string · default: 4

userAgent · enum<string> | null

Available options: web, cli, internal-cli, api, slack, discord, telegram, schedule, unknown, null