Scheduling Intent

Scheduling Intent is a small set of workflow endpoints for booking on a patient's behalf, built to be called by AI agents and other automated callers. Each call does one whole job: find the practices the caller can book at, find bookable slots, book one, check the booking.

It is in beta. Access is turned on per developer organization, for the sandbox and for production separately. Email [email protected] to enroll. Without access, every call returns 403.

How it differs from the rest of the API

It is unversioned. Do not send Nex-Api-Version; a request that carries it returns 400 with reason: unversioned_api. Changes during the beta are additive.
Business failures come back as data, not HTTP errors. When the job cannot be done, the endpoint returns 200 with { "ok": false, "reason": "...", "message": "..." }. message is safe to show to the end user as is; branch your code on reason. Each endpoint page lists its reasons.
A booking has two states. booking_status is NexHealth's view, confirmed or cancelled. ehr_writeback says whether the appointment has reached the practice's health record system: pending, then confirmed or failed, or unknown if the appointment can no longer be found. Poll booking/status until it leaves pending. A practice with no health record integration behind it has nothing to write to, so its bookings stay pending.

Authenticate with the same bearer token as the rest of the API.