Skip to main content
GET
Get consultation status and messages

Authorizations

Authorization
string
header
required

OAuth 2.1 with PKCE

Path Parameters

id
string
required

Consultation/conversation ID

Query Parameters

includeMessages
boolean
default:true

Whether to include message history

Response

Consultation details

Full conversation details with messages

conversationId
string
status
enum<string>

A conversation is a continuous thread — it never "closes." There is no terminal CLOSED/CANCELED status: a finished or canceled request simply leaves the conversation IDLE with its visit history intact.

  • IDLE: AI-only, nothing in progress. Re-engageable — sending a message re-runs triage
  • TRIAGING: AI is gathering symptom information on a live request
  • PAYMENT_REQUIRED: Triage complete, awaiting payment confirmation (or dismissal)
  • MATCHING: Being matched with a healthcare provider
  • WITH_PROVIDER: A provider is connected (messaging is asynchronous)
  • EMERGENCY: Urgent care advised — user should call 911 (not re-engageable)
Available options:
IDLE,
TRIAGING,
PAYMENT_REQUIRED,
MATCHING,
WITH_PROVIDER,
EMERGENCY
statusDescription
string
region
string | null

ISO 3166-2 region this conversation is licensed for

providerVisit
object | null

Present when a provider is in seat

pastVisits
object[]

Prior provider visits on this conversation

messages
object[]

Windowed to the newest messages by default to keep long threads manageable; omittedOlderMessages reports how many older messages exist beyond the window.

omittedOlderMessages
integer

Present when the message window truncated older messages

paymentGate
object

Payment gate information when triage is complete

nextSteps
string[]

Suggested actions based on current status