Skip to content

Nextvisit API (1.0.0)

API for the Nextvisit Clinical Documentation platform for developers

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Nextvisit Support
hello@nextvisit.ai
License
Proprietary
Terms of Service
Languages
Servers
Mock server
https://developers.nextvisit.app/_mock/openapi
Production API
https://nextvisit.app/api
Beta API
https://ea.nextvisit.app/api

Tokens

User token management endpoints for secure access to the Nextvisit platform. Includes login, logout, and token management operations.

Operations

Users

User account management including profile updates, permission settings, role assignments, and practice affiliations.

Operations

Progress Notes

Clinical progress note management including creating, updating, retrieving, and signing notes with associated transcriptions and analyses.

Operations

Billing

Billing and subscription management including plans, usage tracking, and cost estimates.

Operations

Transcription

Audio transcription services including file upload transcription and temporary API tokens for client-side transcription.

Operations

Transcribe audio file

Request

Uploads an audio file and returns the transcribed text using AI-powered speech recognition

Security
bearerAuth
Bodymultipart/form-datarequired
filestring(binary)required

Audio file to transcribe. Supported formats: mp3, mp4, m4a, wav, ogg, webm, flac, aac, pcm, opus. Maximum size: 200MB

curl -i -X POST \
  https://developers.nextvisit.app/_mock/openapi/v1/transcribe/file \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

Transcription completed successfully

Bodyapplication/json
statusstringrequired

Status of the transcription request

Enum"success""error"
Example: "success"
successbooleanrequired

Whether the transcription was successful

Example: true
messagestringrequired

Human-readable status message

Example: "File uploaded successfully."
textstring or null

The transcribed text from the audio file

Example: "Patient reports improvement in symptoms since last visit. Sleep quality has improved with the current medication regimen."
Response
application/json
{
  "status": "success",
  "success": true,
  "message": "File uploaded successfully.",
  "text": "Patient reports improvement in symptoms since last visit. Sleep quality has improved with the current medication regimen. No side effects noted. Will continue current treatment plan and follow up in four weeks."
}

Get temporary transcription token

Request

Returns a temporary speech-to-text API token for client-side websocket audio transcription. The token is short-lived and should be used immediately. Requires a paid plan.

Security
bearerAuth
curl -i -X GET \
  https://developers.nextvisit.app/_mock/openapi/v1/transcribe/token \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Token retrieved successfully

Bodyapplication/json
successbooleanrequired

Whether the token was retrieved successfully

Example: true
messagestringrequired

Human-readable status message

Example: "Token retrieved successfully."
tokenstring or null

Temporary API token for client-side transcription

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Response
application/json
{
  "success": true,
  "message": "Token retrieved successfully.",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Patients

Patient management including creating, updating, retrieving, and searching patient records within your team.

Operations