VEvetnio
consultations

Export raw consultation data

Returns presigned download URLs for the full audio recording, transcription, clinical note, structured JSON document, owner communication, and referral letter of a consultation. Each field is null when the underlying artifact does not yet exist (for example if the clinical note has not been generated). Creator-only playback settings do not apply to this authorized admin export.

Workspace admin only (direct workspace admins and organization admins); other members get 403. Archived or deleted consultations return 403 even though they appear in GET .../data-export/consultations. URLs are valid for 1 hour (expiresAt); call again for fresh ones. Read-only: nothing is generated or changed.

get/workspaces/{workspaceId}/consultations/{consultationId}/data-export

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}/data-export
  • 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

Response

Presigned download URLs for the consultation's stored artifacts.

structuredDocumentstring nullable required

Presigned GET URL for the separately stored structured JSON document, or null if none exists. The payload matches the JSON template used to generate it; it is not the rendered clinical note.

communicationstring nullable required

Presigned GET URL for the owner communication in its stored format, or null if none exists.

referralstring nullable required

Presigned GET URL for the referral letter in its stored format, or null if none exists.

consultationIdstring required

The consultation these artifacts belong to.

workspaceIdstring required

The workspace that owns the consultation.

externalIdstring nullable required

External ID from an integrated system, or null if the consultation is not linked to one.

expiresInSecondsnumber required

How long each presigned download URL remains valid, in seconds.

expiresAtstring required

ISO-8601 timestamp at which the download URLs expire. Provided for convenience so clients can display a countdown without computing it themselves.

audioRecordingstring nullable required

Presigned GET URL for the full consultation audio: every uploaded recording joined into one 16 kHz mono WAV file, silence included. null if no audio exists (for example a text-only consultation, or audio removed by the clinic's audio-retention policy). Creator-only playback settings do not apply to authorized admin exports.

transcriptionstring nullable required

Presigned GET URL for the full transcript as a UTF-8 plain-text file (the same text as GET .../transcription), or null if nothing has been transcribed yet.

clinicalNotestring nullable required

Presigned GET URL for the stored clinical note (HTML, or JSON for structured notes), or null if no note has been saved yet.

Example response

{
  "consultationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "workspaceId": "furunculotic-loud-chihuahua",
  "externalId": "123456",
  "expiresInSeconds": 3600,
  "expiresAt": "2026-04-16T13:00:00.000Z",
  "audioRecording": "https://example-bucket.s3.eu-central-1.amazonaws.com/fullRecordings/furunculotic-loud-chihuahua/a1b2c3d4-e5f6-7890-abcd-ef1234567890?X-Amz-Expires=3600&X-Amz-Signature=..."
}

Changes

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