VEvetnio
consultations

Get consultation transcript

Returns the saved full transcript of a consultation as plain text, or an empty string if none has been saved. By default it returns immediately and does not start transcription: call POST .../transcriptions/start and poll GET .../consultations/{consultationId} until transcriptionStatus is completed or failed before reading it.

Set waitForTranscriptions=true to start transcription and wait for it in one call, using the same completion flow as document generation; this requires write access. Waiting is best effort: stale jobs, permanent failures, exhausted retries or the 10-minute limit can leave a partial transcript, and the response does not say which happened, so check transcriptionStatus afterwards. Set your HTTP client timeout above 10 minutes when waiting.

Any member of the workspace can read the transcript, including for archived consultations.

get/workspaces/{workspaceId}/consultations/{consultationId}/transcription

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}/transcription
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Identifier of the consultation (UUID), as returned when it was created or by GET /workspaces/{workspaceId}/consultations. It must belong to the clinic in workspaceId.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Query parameters

boolean
OR
'true' | 'false'

Response

The consultation's full transcript.

transcriptionstring required

Full transcript as plain text, or an empty string if nothing has been transcribed yet. Built from the consultation's partial transcriptions in recording order, joined with a single space; text partial transcriptions are included verbatim. Within a recording, a change of speaker starts a new paragraph (blank line), but speakers are not labelled. Medical terms that the spelling check is very confident about are annotated inline as term (Suggestion?).

Example response

{
  "transcription": "So this is Bella, she's here for her annual vaccines.\n\nGreat. Any problems since last time?\n\nShe's still on Rimadil (Rimadyl?) for her hip, otherwise fine."
}

Changes

No recorded changes to this operation across all 1 revision of this API.