Endpoint Reference
POST `/sessions`
Create a partner chat session.
POST `/sessions`
EndpointCreate a partner chat session.
When to use:
- Start of a new chat lifecycle
- No active session is mapped for this actor
Request fields:
| Field | Type | Required | Description |
|---|---|---|---|
actor.actorId | string | Yes | Stable user ID in partner system |
actor.timezoneOffsetMinutes | number | No | UTC offset minutes for date parsing |
channel.workspaceId | string | No | Partner workspace/group identifier |
conversation.channelId | string | No | Partner conversation bucket key |
conversation.id | string | No | Explicit conversation ID for tracing |
conversation.threadTs | string | No | Explicit 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 required400:Invalid JSON payload401,403,429: auth/quota