Skip to content
/Document

Askara API (1.0.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

Retrieve collection of document entities.

Request

Use this endpoint to retrieve the collection of document information.

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[createdAt]string
Enum"asc""desc"
order[updatedAt]string
Enum"asc""desc"
order[verifiedAt]string
Enum"asc""desc"
order[sentAt]string
Enum"asc""desc"
order[user]string
Enum"asc""desc"
order[patient]string
Enum"asc""desc"
expand[]Array of strings
Items Enum"user.read""user.list""document.read_patient""patient.read""patient.list""pdf.list""pdf.read"
searchstring

Global case-insensitive text search.

synchronizedboolean

Filter documents by synchronization status with the current OAuth client

uuidstring
uuid[]Array of strings
user.emailstring
user.email[]Array of strings
patient.emailstring
patient.email[]Array of strings
typestring
type[]Array of strings
pdfstring
pdf[]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
encounteredAt[between]string
encounteredAt[gt]string
encounteredAt[gte]string
encounteredAt[lt]string
encounteredAt[lte]string
exists[encounteredAt]boolean
user.uuidstring
user.uuid[]Array of strings
patient.uuidstring
patient.uuid[]Array of strings
isAnonymizedboolean
curl -i -X GET \
  'https://api.askara.ai/documents?page=1&itemsPerPage=20&order%5Buuid%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5BverifiedAt%5D=asc&order%5BsentAt%5D=asc&order%5Buser%5D=asc&order%5Bpatient%5D=asc&expand%5B%5D=user.read&search=string&synchronized=true&uuid=string&uuid%5B%5D=string&user.email=string&user.email%5B%5D=string&patient.email=string&patient.email%5B%5D=string&type=string&type%5B%5D=string&pdf=string&pdf%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&encounteredAt%5Bbetween%5D=string&encounteredAt%5Bgt%5D=string&encounteredAt%5Bgte%5D=string&encounteredAt%5Blt%5D=string&encounteredAt%5Blte%5D=string&exists%5BencounteredAt%5D=true&user.uuid=string&user.uuid%5B%5D=string&patient.uuid=string&patient.uuid%5B%5D=string&isAnonymized=true'

Responses

Document collection

Body
Array [
uuidstring(uuid)

Document unique identifier.

createdAtstring(date-time)

Document creation date.

updatedAtstring(date-time)

Document update date.

encounteredAtstring or null(date-time)

Document operation/cone beam specific date.

userstring(uuid)

Document author.

Example: "123e4567-e89b-12d3-a456-426614174000"
patientstring(uuid)

Document patient.

Example: "123e4567-e89b-12d3-a456-426614174000"
typestring or null

Document type.

Enum"operative_report""referral_letter""cone_beam_report""patient_letter""prescription""initial_medical_certificate""attendance_certificate""contraindication_certificate""lab_slip""endo_report"
pdfstring or null(uuid)

Document PDF file.

Example: "123e4567-e89b-12d3-a456-426614174000"
isAnonymizedboolean

Document anonymization status.

Default false
]
Response
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "encounteredAt": "2019-08-24T14:15:22Z",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "patient": "123e4567-e89b-12d3-a456-426614174000",
    "type": "operative_report",
    "pdf": "123e4567-e89b-12d3-a456-426614174000",
    "isAnonymized": false
  }
]

Retrieve a document entity.

Request

Use this endpoint to retrieve a document information.

Path
uuidstringrequired

Document identifier

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

Responses

Document resource

Body
uuidstring(uuid)

Document unique identifier.

createdAtstring(date-time)

Document creation date.

updatedAtstring(date-time)

Document update date.

encounteredAtstring or null(date-time)

Document operation/cone beam specific date.

userobject(User-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list)
patientobject(Patient-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list)
audioAudio-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list (object) or null
Any of:
object Audio-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list Recursive
typestring or null

Document type.

Enum"operative_report""referral_letter""cone_beam_report""patient_letter""prescription""initial_medical_certificate""attendance_certificate""contraindication_certificate""lab_slip""endo_report"
pdfPdf-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list (object) or null
Any of:
object Pdf-document.read_document.read_integrations_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list Recursive
isAnonymizedboolean

Document anonymization status.

Default false
Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "encounteredAt": "2019-08-24T14:15:22Z",
  "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"
  },
  "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"
  },
  "audio": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "patient": { … },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "archivedAt": "2019-08-24T14:15:22Z",
    "audioWorkflowStepV3": "audio_recording"
  },
  "type": "operative_report",
  "pdf": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "size": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "url": "string",
    "fileName": "string"
  },
  "isAnonymized": false
}

Set a document synchronization status.

Request

Use this endpoint to set a document synchronization status.

Path
uuidstringrequired

Document identifier

Body
required

The new Document resource

successboolean or nullrequired

Whether the synchronization was successful or not.

errorstring or null

Optional but recommended: Error message if synchronization failed (only when success is false).

curl -i -X POST \
  'https://api.askara.ai/documents/{uuid}/status' \
  -H 'Content-Type: application/json' \
  -d '{
    "success": true,
    "error": "string"
  }'

Responses

Document resource created

Body
uuidstring(uuid)

Document unique identifier.

createdAtstring(date-time)

Document creation date.

updatedAtstring(date-time)

Document update date.

encounteredAtstring or null(date-time)

Document operation/cone beam specific date.

userobject(User-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list)
patientobject(Patient-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list)
audioAudio-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list (object) or null
Any of:
object Audio-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list Recursive
typestring or null

Document type.

Enum"operative_report""referral_letter""cone_beam_report""patient_letter""prescription""initial_medical_certificate""attendance_certificate""contraindication_certificate""lab_slip""endo_report"
pdfPdf-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list (object) or null
Any of:
object Pdf-document.read_document.read_patient_patient.list_user.list_document.read_pdf_pdf.list_document.read_emails_email.list_email_tag.list_document.read_audio_audio.list Recursive
isAnonymizedboolean

Document anonymization status.

Default false
Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "encounteredAt": "2019-08-24T14:15:22Z",
  "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"
  },
  "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"
  },
  "audio": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "patient": { … },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "archivedAt": "2019-08-24T14:15:22Z",
    "audioWorkflowStepV3": "audio_recording"
  },
  "type": "operative_report",
  "pdf": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "size": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "url": "string",
    "fileName": "string"
  },
  "isAnonymized": false
}

Organization

Resource 'Organization' operations.

Operations

Patient

Resource 'Patient' operations.

Operations

User

Resource 'User' operations.

Operations

Webhook

Resource 'Webhook' operations.

Operations