Recordings API

get /visits/{id}/recordings/{recording_id}

Get recording

Base URL https://api.vseepreview.com/api_v3 · operationId getRecording

Authentication: Admin Token — Requires the Clinic Admin API Token from your dashboard (Developers → App → Edit App).

Retrieve a specific recording with download URL

Parameters

NameInTypeRequiredEnumDefaultDescription
X-ApiTokenheaderstringyesAPI token (e.g. your_api_token)
X-AccountCodeheaderstringyesAccount code (e.g. vclinic)
idpathstringyesVisit ID
recording_idpathstringyesRecording ID from visits.data.recordings.id

Responses

200 — Recording details with download URL

success

{
  "id": 111,
  "visit_id": 82828,
  "end": 1633966813,
  "start": 1633966696,
  "version": 3,
  "participants": [
    {
      "first_name": "Keven2",
      "last_name": "Teodoro2",
      "vseeid": "conciergedev+user575"
    },
    {
      "first_name": "Keven2",
      "last_name": "Teodoro2",
      "vseeid": "provider.w@vclinic.com"
    }
  ],
  "path": {
    "url": "https://recordings-bucket.example-s3.amazonaws.com/EXAMPLE_CLINIC/1636431607681_recording__example.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211112T151817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=EXAMPLEACCESSKEYID123%2F20211112%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=EXAMPLESIGNATUREdonotusethisvalueitisaplaceholder00000000",
    "expiry": 1634966813
  }
}

Machine-readable: OpenAPI JSON (operationId: getRecording)