Skip to content
OnCoreDocs
Web Chat

POSThttps://core-api.heysadie.ai/web-chat/session

phoneNumber visitorId sessionToken expiresIn success error code message details field metadata timestamp version path

Start web chat session

Try it in the API Explorer

Example request

Terminal
curl -X POST "https://core-api.heysadie.ai/web-chat/session" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "string"
  }'

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.

Request

Body application/json · required

phoneNumberstringrequired

E.164-formatted phone number owned by the calling tenant and assigned to an assistant (e.g. +15555550123).

visitorIdstringoptional

Optional stable, unique-per-end-user identifier the reseller controls (e.g. their user id, or a random id persisted in the visitor's cookie/localStorage). Supplying it keeps the conversation continuous across token refreshes and page reloads. Omit for an ephemeral one-shot session.

Responses

200
sessionTokenstringrequired

Short-lived (default 30 min) HMAC session token. Pass to the browser as `Authorization: Bearer <sessionToken>` on /web-chat/messages and /web-chat/end.

expiresInnumberrequired

Token lifetime in seconds (default 1800).

400
successbooleanrequired
errorobjectoptional
Show 3 child properties
codeenumrequired
Allowed values:"VALIDATION_ERROR"
messagestringrequired
detailsobject[]optional
Show 2 item properties
fieldstringrequired
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
401
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"UNAUTHORIZED"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
403
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"FORBIDDEN"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
404
errorenumrequired
Allowed values:"not_found"
500
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional