Scribe

Transcribe Scribe Recording

post

Transcribe a completed Superscribe clinical recording.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

multipart/form-data

audiostringRequired

service_idstring · uuidRequired

patient_entity_idany ofOptional

string · uuidOptional

or

nullOptional

languageany ofOptional

string · max: 16Optional

or

nullOptional

keytermsany ofOptional

string · max: 4000Optional

or

nullOptional

Responses

200

Successful Response

application/json

transcriptstringRequired

confidenceany ofOptional

numberOptional

or

nullOptional

duration_secondsnumberRequired

modelstringRequired

languagestringRequired

chunk_countintegerRequired

keyterm_countintegerRequired

422

Validation Error

application/json

post

/v1/{workspace_id}/scribe/recordings/transcribe

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/scribe/recordings/transcribe HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 163

{
  "audio": "text",
  "service_id": "123e4567-e89b-12d3-a456-426614174000",
  "patient_entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "language": "text",
  "keyterms": "text"
}

{
  "transcript": "text",
  "confidence": 1,
  "duration_seconds": 1,
  "model": "text",
  "language": "text",
  "chunk_count": 1,
  "keyterm_count": 1,
  "chunks": [
    {
      "index": 1,
      "start_seconds": 1,
      "end_seconds": 1,
      "text": "text",
      "confidence": 1,
      "duration_seconds": 1
    }
  ],
  "segments": [
    {
      "text": "text",
      "start_seconds": 1,
      "end_seconds": 1,
      "confidence": 1,
      "speaker": 1
    }
  ]
}

Approve Icd10

post

Physician approves an ICD-10 code. Writes at HIGH confidence (0.9).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

encounter_idstring · uuidRequired

Body

application/json

codestring · max: 16Required

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

post

/v1/{workspace_id}/scribe/encounters/{encounter_id}/icd10/approve

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/scribe/encounters/{encounter_id}/icd10/approve HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "code": "text"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Reject Icd10

post

Physician rejects an ICD-10 code. Writes at HIGH confidence (0.9).

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

encounter_idstring · uuidRequired

Body

application/json

codestring · max: 16Required

reasonany ofOptional

string · max: 500Optional

or

nullOptional

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

post

/v1/{workspace_id}/scribe/encounters/{encounter_id}/icd10/reject

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/scribe/encounters/{encounter_id}/icd10/reject HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "code": "text",
  "reason": "text"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Edit Soap

post

Physician edits a SOAP section. Writes at HIGH confidence (0.9) — supersedes agent observations.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

encounter_idstring · uuidRequired

Body

application/json

sectionstringRequiredPattern: ^(subjective|objective|assessment|plan)$

contentstring · max: 10000Required

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

post

/v1/{workspace_id}/scribe/encounters/{encounter_id}/soap/edit

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/scribe/encounters/{encounter_id}/soap/edit HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "section": "text",
  "content": "text"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Finalize Encounter

post

Physician finalizes the encounter. Locks the encounter for EHR sync.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

encounter_idstring · uuidRequired

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

post

/v1/{workspace_id}/scribe/encounters/{encounter_id}/finalize

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/scribe/encounters/{encounter_id}/finalize HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}