Skip to content

HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Powered by HeyDonto
Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/heydonto/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Site Appointment Types

Operations

Appointment Type

Operations

Brands

Operations

Dental Practices

Operations

Dental Services

Operations

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Site Assistants

Operations

Retrieve all site assistants for a site

Request

Security
bearer
Path
siteIdnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of site assistants retrieved successfully.

Bodyapplication/jsonArray [
assistantNamestring

The name of the assistant for the site

Example: "HeyDonto AI"
assistantInstructionsstring

Instructions for the assistant

Example: "Ensure all appointments are updated daily."
siteIdnumberrequired

The ID of the site the assistant is associated with

Example: 123
idnumberrequired

The ID of the assistant

Example: 456
]
Response
application/json
[
  {
    "assistantName": "HeyDonto AI",
    "assistantInstructions": "Ensure all appointments are updated daily.",
    "siteId": 123,
    "id": 456
  }
]

Create a new site assistant

Request

Security
bearer
Path
siteIdnumberrequired
Bodyapplication/jsonrequired
assistantNamestring

The name of the assistant for the site

Example: "HeyDonto AI"
assistantInstructionsstring

Instructions for the assistant

Example: "Ensure all appointments are updated daily."
siteIdnumberrequired

The ID of the site the assistant is associated with

Example: 123
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assistantName": "HeyDonto AI",
    "assistantInstructions": "Ensure all appointments are updated daily.",
    "siteId": 123
  }'

Responses

Site assistant created successfully.

Bodyapplication/json
assistantNamestring

The name of the assistant for the site

Example: "HeyDonto AI"
assistantInstructionsstring

Instructions for the assistant

Example: "Ensure all appointments are updated daily."
siteIdnumberrequired

The ID of the site the assistant is associated with

Example: 123
idnumberrequired

The ID of the assistant

Example: 456
Response
application/json
{
  "assistantName": "HeyDonto AI",
  "assistantInstructions": "Ensure all appointments are updated daily.",
  "siteId": 123,
  "id": 456
}

Retrieve a site assistant by ID

Request

Security
bearer
Path
siteIdnumberrequired
siteAssistantIdnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant/{siteAssistantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site assistant retrieved successfully.

Bodyapplication/json
assistantNamestring

The name of the assistant for the site

Example: "HeyDonto AI"
assistantInstructionsstring

Instructions for the assistant

Example: "Ensure all appointments are updated daily."
siteIdnumberrequired

The ID of the site the assistant is associated with

Example: 123
idnumberrequired

The ID of the assistant

Example: 456
Response
application/json
{
  "assistantName": "HeyDonto AI",
  "assistantInstructions": "Ensure all appointments are updated daily.",
  "siteId": 123,
  "id": 456
}

Update an existing site assistant

Request

Security
bearer
Path
siteIdnumberrequired
siteAssistantIdnumberrequired
Bodyapplication/jsonrequired
assistantNamestring

The name of the assistant for the site

Example: "HeyDonto AI"
assistantInstructionsstring

Instructions for the assistant

Example: "Ensure all appointments are updated daily."
siteIdnumberrequired

The ID of the site the assistant is associated with

Example: 123
idnumberrequired

The ID of the assistant to be updated

Example: 456
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant/{siteAssistantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "assistantName": "HeyDonto AI",
    "assistantInstructions": "Ensure all appointments are updated daily.",
    "siteId": 123,
    "id": 456
  }'

Responses

Site assistant updated successfully.

Bodyapplication/json
assistantNamestring

The name of the assistant for the site

Example: "HeyDonto AI"
assistantInstructionsstring

Instructions for the assistant

Example: "Ensure all appointments are updated daily."
siteIdnumberrequired

The ID of the site the assistant is associated with

Example: 123
idnumberrequired

The ID of the assistant

Example: 456
Response
application/json
{
  "assistantName": "HeyDonto AI",
  "assistantInstructions": "Ensure all appointments are updated daily.",
  "siteId": 123,
  "id": 456
}

Delete a site assistant

Request

Security
bearer
Path
siteIdnumberrequired
siteAssistantIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant/{siteAssistantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site assistant deleted successfully.

Response
No content

Upload a file to the site assistant

Request

Security
bearer
Path
siteIdnumberrequired
siteAssistantIdnumberrequired
Query
descriptionstring

A description for the uploaded file

Example: description=Instructions document for the assistant
Bodymultipart/form-datarequired
filestring(binary)required

The file to be uploaded

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant/{siteAssistantId}/files?description=Instructions+document+for+the+assistant' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

File uploaded successfully.

Response
No content

Delete a file associated with the site assistant

Request

Security
bearer
Path
siteIdnumberrequired
siteAssistantIdnumberrequired
assistantFileIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant/{siteAssistantId}/files/{assistantFileId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

File deleted successfully.

Response
No content

Send a chat message to the site assistant

Request

Security
bearer
Path
siteIdnumberrequired
siteAssistantIdnumberrequired
Bodyapplication/jsonrequired
messagestringrequired

The message content to be sent to the assistant

Example: "Please update all appointments for today."
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/assistant/{siteAssistantId}/chat' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "message": "Please update all appointments for today."
  }'

Responses

Chat message sent successfully.

Response
No content

Periomeasure

Operations

Availability

Operations

Users

Operations

Billing Information

Operations