Skip to content
/Note

Askara API (1.1.0)

Askara.ai open API

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

Audio

Resource 'Audio' operations.

Operations

Contact

Resource 'Contact' operations.

Operations

Document

Resource 'Document' operations.

Operations

Note

Resource 'Note' operations.

Operations

Retrieve collection of notes.

Request

Use this endpoint to retrieve a collection of notes.

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 100 ]

The number of items per page

Default 20
order[uuid]string
Enum"asc""desc"
order[type]string
Enum"asc""desc"
order[createdAt]string
Enum"asc""desc"
order[updatedAt]string
Enum"asc""desc"
uuidstring
uuid[]Array of strings
typestring
type[]Array of strings
patientstring
patient[]Array of strings
audiostring
audio[]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
curl -i -X GET \
  'https://api.askara.ai/notes?page=1&itemsPerPage=20&order%5Buuid%5D=asc&order%5Btype%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&uuid=string&uuid%5B%5D=string&type=string&type%5B%5D=string&patient=string&patient%5B%5D=string&audio=string&audio%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'

Responses

Note collection

Body
Array [
uuidstring(uuid)
contentstring or null

Note content.

typestring

Note type.

Enum"consultation_summary""meeting_summary""ortho_summary"
patientPatient-note.list_patient.list (object) or null
Any of:
createdAtstring(date-time)

Note creation date.

updatedAtstring(date-time)

Note last update date.

]
Response
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "content": "string",
    "type": "consultation_summary",
    "patient": { … },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

Retrieve a note.

Request

Use this endpoint to retrieve a note information.

Path
uuidstringrequired

Note identifier

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

Responses

Note resource

Body
uuidstring(uuid)
contentstring or null

Note content.

typestring

Note type.

Enum"consultation_summary""meeting_summary""ortho_summary"
audiostring or null(uuid)

Associated audio.

Example: "123e4567-e89b-12d3-a456-426614174000"
patientPatient-note.read_note.read_audio_note.read_user_patient.list_user.list (object) or null
Any of:
userobject(User-note.read_note.read_audio_note.read_user_patient.list_user.list)
createdAtstring(date-time)

Note creation date.

updatedAtstring(date-time)

Note last update date.

Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "content": "string",
  "type": "consultation_summary",
  "audio": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  },
  "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"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Organization

Resource 'Organization' operations.

Operations

Patient

Resource 'Patient' operations.

Operations

User

Resource 'User' operations.

Operations

Webhook

Resource 'Webhook' operations.

Operations