Endpoint Reference

POST `/sessions`

Create a partner chat session.

MethodPOST
Path/sessions
Endpoint1/3
Base Path/api/partner/v1/core-chat

POST `/sessions`

Endpoint

Create a partner chat session.

When to use:

  • Start of a new chat lifecycle
  • No active session is mapped for this actor

Request fields:

FieldTypeRequiredDescription
actor.actorIdstringYesStable user ID in partner system
actor.timezoneOffsetMinutesnumberNoUTC offset minutes for date parsing
channel.workspaceIdstringNoPartner workspace/group identifier
conversation.channelIdstringNoPartner conversation bucket key
conversation.idstringNoExplicit conversation ID for tracing
conversation.threadTsstringNoExplicit thread key from partner model

Example request:

curl "$BREK_BASE_URL/api/partner/v1/core-chat/sessions" \
  -H "x-partner-api-key: $BREK_PARTNER_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "actor": {
      "actorId": "partner_user_001",
      "timezoneOffsetMinutes": -480
    },
    "channel": {
      "workspaceId": "partner-workspace"
    },
    "conversation": {
      "channelId": "partner-chat"
    }
  }'

Example success (200):

{
  "data": {
    "sessionId": "sess_1771456953407_g7p6233d",
    "tenantId": "demo-tenant",
    "channel": {
      "type": "partner_api",
      "workspaceId": "partner-workspace"
    },
    "conversation": {
      "id": "partner-chat:sess_1771456953407_g7p6233d",
      "channelId": "partner-chat",
      "threadTs": "sess_1771456953407_g7p6233d"
    },
    "actor": {
      "actorId": "partner_user_001",
      "timezoneOffsetMinutes": -480
    },
    "createdAt": "2026-02-18T23:22:33.407Z",
    "updatedAt": "2026-02-18T23:22:33.407Z",
    "events": []
  }
}

Common errors:

  • 400: actor.actorId is required
  • 400: Invalid JSON payload
  • 401, 403, 429: auth/quota