API documentation

Start Assistant

post/api/v1/chat/start

Starts a new chat session. Signed-in users receive authenticated research tools; anonymous callers must pass bot verification and receive a session token for follow-up requests.

Chat

Request body

{
  "locale": "Example",
  "pageUrl": "Example",
  "referrer": "Example",
  "turnstileToken": "Example",
  "clientSurface": "Example"
}

Responses

200Session id, session token, and display name for the assistant.application/json

{
  "sessionId": "84663654-d102-4d64-98c6-5f8bbce52858",
  "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…",
  "agentName": "Obermind"
}

400Bot verification failed for anonymous callers.application/json

{
  "type": "Deposit",
  "title": "Example",
  "status": 1,
  "detail": "The request could not be completed. Check the values and try again.",
  "instance": "Example"
}

429Too many sessions from the same client.application/json

{
  "type": "Deposit",
  "title": "Example",
  "status": 1,
  "detail": "The request could not be completed. Check the values and try again.",
  "instance": "Example"
}

503Chat is disabled on this environment.

Launch Your Platform.

Get Started.Try it out.