How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Luma Health Assistant Instances API

Conversations between the Navigator AI assistant and a patient or staff member

Luma Health Assistant Instances API is one of 58 APIs that Luma Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 8 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.lumahealth.io/api/v2.

8 operations 5 paths 12 schemas 1 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.lumahealth.io/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Luma Health Assistant Instances API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

assistantInstances 8

Conversations between the Navigator AI assistant and a patient or staff member

GET
/assistantInstances
List assistant instances
assistantInstancesList 14 params → 200401403
POST
/assistantInstances
Create an assistant instance
assistantInstanceCreate body → 201401403
GET
/assistantInstances/{assistantInstanceId}
Get assistant instance by id
assistantInstanceGet 1 param → 200401403
PUT
/assistantInstances/{assistantInstanceId}
Update an assistant instance
assistantInstanceUpdate 1 param body → 200401403
DELETE
/assistantInstances/{assistantInstanceId}
Delete an assistant instance
assistantInstanceDelete 1 param → 200401403
GET
/assistantInstances/{assistantInstanceId}/analysis
Get the analysis timeline for an assistant instance
assistantInstanceGetAnalysis 1 param → 200401403404
GET
/assistantInstances/{assistantInstanceId}/reporting
Get QA reporting data for an assistant instance
assistantInstanceGetReportingData 1 param → 200401403404
POST
/assistantInstances/patients/{patientId}/completions
Generate an assistant chat completion for a patient
assistantInstanceCompletion 1 param body → 200400401403

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AssistantInstanceRequestCreate (20 properties), AssistantInstanceResponse (20 properties), AssistantInstanceRequestUpdate (20 properties), AssistantActionResponse (13 properties). Each schema is shown below with its type and property counts.

userParam
string
The ID of the root account user.
Error
object
2 properties 2 required
AssistantInstanceRequestUpdate
object
20 properties
AssistantInstanceResponse
object
An AssistantInstance represents a single conversation between Luma's Navigator AI assistant and a patient (or staff member), spanning one or more channels such…
20 properties
AssistantActionResponse
object
An AssistantAction is an audit-log record of a single tool or function call made by the Navigator AI assistant during a conversation, such as listing appointme…
13 properties
AssistantInstanceRequestCreate
object
20 properties 1 required
idParam
string
Luma's internal ID of an object.
updatedAtParam
string
The date/time when this object was updated.
createdAtParam
string
The date/time when this object was created.
updatedByParam
string
The ID of the user who updated this object.
deletedParam
number
Flag for logical deletion where 1 means deleted.
createdByParam
string
The ID of the user who created this object.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

luma-health-assistantinstances-api-openapi.yml Raw ↑

Other APIs Luma Health publishes across the network.

Luma Health Appointments API
Luma Health Appointment Types API
Luma Health Assistant Actions API
Luma Health Assistant Transfer Rules API
Luma Health Auth API
Luma Health Availabilities API
Luma Health Billing Charges API
Luma Health Billing Copays API
Luma Health Broadcast Templates API
Luma Health Broadcast Events API
Luma Health Broadcast Flows API
Luma Health Campaigns API
Where this information came from

This is an independent, third-party profile of Luma Health Assistant Instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.