Skip to content
/Audio

Askara API (1.1.0)

Askara.ai open API

Languages
Servers
Production
https://api.askara.ai

Audio

Resource 'Audio' operations.

Operations

Retrieve collection of audios.

Request

Use this endpoint to retrieve the collection of audio information.

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 100 ]

The number of items per page

Default 20
expand[]Array of strings
Items Enum"patient.read""patient.list"
order[uuid]string
Enum"asc""desc"
order[patient]string
Enum"asc""desc"
order[createdAt]string
Enum"asc""desc"
order[updatedAt]string
Enum"asc""desc"
order[archivedAt]string
Enum"asc""desc"
searchstring

Global case-insensitive and accent-insensitive text search.

exists[archivedAt]boolean
uuidstring
uuid[]Array of strings
patientstring
patient[]Array of strings
documentsstring
documents[]Array of strings
userstring
user[]Array of strings
languageSpokenstring
languageSpoken[]Array of strings
createdAt[between]string
createdAt[gt]string
createdAt[gte]string
createdAt[lt]string
createdAt[lte]string
updatedAt[between]string
updatedAt[gt]string
updatedAt[gte]string
updatedAt[lt]string
updatedAt[lte]string
archivedAt[between]string
archivedAt[gt]string
archivedAt[gte]string
archivedAt[lt]string
archivedAt[lte]string
curl -i -X GET \
  'https://api.askara.ai/audios?page=1&itemsPerPage=20&expand%5B%5D=patient.read&order%5Buuid%5D=asc&order%5Bpatient%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5BarchivedAt%5D=asc&search=string&exists%5BarchivedAt%5D=true&uuid=string&uuid%5B%5D=string&patient=string&patient%5B%5D=string&documents=string&documents%5B%5D=string&user=string&user%5B%5D=string&languageSpoken=string&languageSpoken%5B%5D=string&createdAt%5Bbetween%5D=string&createdAt%5Bgt%5D=string&createdAt%5Bgte%5D=string&createdAt%5Blt%5D=string&createdAt%5Blte%5D=string&updatedAt%5Bbetween%5D=string&updatedAt%5Bgt%5D=string&updatedAt%5Bgte%5D=string&updatedAt%5Blt%5D=string&updatedAt%5Blte%5D=string&archivedAt%5Bbetween%5D=string&archivedAt%5Bgt%5D=string&archivedAt%5Bgte%5D=string&archivedAt%5Blt%5D=string&archivedAt%5Blte%5D=string'

Responses

Audio collection

Body
Array [
uuidstring(uuid)

Audio unique identifier.

patientstring or null(uuid)

Audio patient.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)

Audio creation date.

updatedAtstring(date-time)

Audio update date.

archivedAtstring or null(date-time)

Audio archive date.

userUser-audio.list_audio.read_user_user.list (object) or null
Any of:
audioWorkflowStepV3stringread-only

Get the current audio workflow step (v3).

Enum"audio_recording""transcription""transcribed""edition""validated""failed"
]
Response
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "patient": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "archivedAt": "2019-08-24T14:15:22Z",
    "user": { … },
    "audioWorkflowStepV3": "audio_recording"
  }
]

Retrieve an audio.

Request

Use this endpoint to retrieve an audio information.

Path
uuidstringrequired

Audio identifier

curl -i -X GET \
  'https://api.askara.ai/audios/{uuid}'

Responses

Audio resource

Body
uuidstring(uuid)

Audio unique identifier.

patientPatient-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list (object) or null
Any of:
createdAtstring(date-time)

Audio creation date.

updatedAtstring(date-time)

Audio update date.

archivedAtstring or null(date-time)

Audio archive date.

documentsArray of objects(Document-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list)
imagesArray of objects(Image-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list)
meetingstring or null(uuid)

Associated meeting.

Example: "123e4567-e89b-12d3-a456-426614174000"
userUser-audio.read_audio.read_user_user.list_audio.read_images_image.list_patient.list_audio.read_documents_document.read_document.read_integrations_client.list_document.read_pdf_pdf.list (object) or null
Any of:
languageSpokenstring or null

Audio spoken language.

Default "fr"
mediaRecorderTypestring or nullread-only

Get the media recorder type of this audio.

audioWorkflowStepV3stringread-only

Get the current audio workflow step (v3).

Enum"audio_recording""transcription""transcribed""edition""validated""failed"
Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "patient": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "firstName": "string",
    "lastName": "string",
    "languageSpoken": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "synchronizedAt": "2019-08-24T14:15:22Z",
    "dateOfBirth": "2019-08-24T14:15:22Z",
    "gender": "female",
    "visibilityOption": "shared",
    "email": "user@example.com",
    "phone": "+33757590893",
    "anonymousCode": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "archivedAt": "2019-08-24T14:15:22Z",
  "documents": [
    { … }
  ],
  "images": [
    { … }
  ],
  "meeting": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "email": "user@example.com",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "lastName": "string",
    "gender": "female",
    "phone": "+33757590893",
    "rpps": "10101748050",
    "am": "394003552"
  },
  "languageSpoken": "fr",
  "mediaRecorderType": "string",
  "audioWorkflowStepV3": "audio_recording"
}

Contact

Resource 'Contact' operations.

Operations

Document

Resource 'Document' operations.

Operations

Note

Resource 'Note' operations.

Operations

Organization

Resource 'Organization' operations.

Operations

Patient

Resource 'Patient' operations.

Operations

User

Resource 'User' operations.

Operations

Webhook

Resource 'Webhook' operations.

Operations