Skip to content
Askara API
/
Document

Askara API (1.0.0)

Askara.ai open API

Languages
Servers
Production

https://api.askara.ai/

Contact

Operations

Document

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[id]string
Default "asc"
Enum"asc""desc"
order[uuid]string
Default "asc"
Enum"asc""desc"
order[createdAt]string
Default "asc"
Enum"asc""desc"
order[updatedAt]string
Default "asc"
Enum"asc""desc"
order[encounteredAt]string
Default "asc"
Enum"asc""desc"
order[dataDeletedAt]string
Default "asc"
Enum"asc""desc"
order[verifiedAt]string
Default "asc"
Enum"asc""desc"
order[sentAt]string
Default "asc"
Enum"asc""desc"
order[generateStartedAt]string
Default "asc"
Enum"asc""desc"
order[generateEndedAt]string
Default "asc"
Enum"asc""desc"
order[transcription]string
Default "asc"
Enum"asc""desc"
order[generateError]string
Default "asc"
Enum"asc""desc"
order[generationDuration]string
Default "asc"
Enum"asc""desc"
order[originalText]string
Default "asc"
Enum"asc""desc"
order[text]string
Default "asc"
Enum"asc""desc"
order[generator]string
Default "asc"
Enum"asc""desc"
order[generatorModel]string
Default "asc"
Enum"asc""desc"
order[generatorTopP]string
Default "asc"
Enum"asc""desc"
order[generatorTemperature]string
Default "asc"
Enum"asc""desc"
order[generatorScoring]string
Default "asc"
Enum"asc""desc"
order[type]string
Default "asc"
Enum"asc""desc"
order[isAnonymized]string
Default "asc"
Enum"asc""desc"
expand[]Array of strings
Items Enum"document.read_user""document.read_patient""document.read_pdf""document.read_user_session"
searchstring

Global case-insensitive text search.

idinteger
id[]Array of integers
uuidstring
uuid[]Array of strings
user.emailstring
user.email[]Array of strings
user.uuidstring
user.uuid[]Array of strings
userSessionstring
userSession[]Array of strings
patient.emailstring
patient.email[]Array of strings
patient.uuidstring
patient.uuid[]Array of strings
transcriptionstring
generateErrorstring
originalTextstring
textstring
generatorstring
generator[]Array of strings
generatorModelstring
generatorModel[]Array of strings
audiostring
audio[]Array of strings
typestring
type[]Array of strings
pdfstring
pdf[]Array of strings
isAnonymizedboolean
isAnonymized[]Array of booleans
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
dataDeletedAt[between]string
dataDeletedAt[gt]string
dataDeletedAt[gte]string
dataDeletedAt[lt]string
dataDeletedAt[lte]string
verifiedAt[between]string
verifiedAt[gt]string
verifiedAt[gte]string
verifiedAt[lt]string
verifiedAt[lte]string
sentAt[between]string
sentAt[gt]string
sentAt[gte]string
sentAt[lt]string
sentAt[lte]string
generateStartedAt[between]string
generateStartedAt[gt]string
generateStartedAt[gte]string
generateStartedAt[lt]string
generateStartedAt[lte]string
generateEndedAt[between]string
generateEndedAt[gt]string
generateEndedAt[gte]string
generateEndedAt[lt]string
generateEndedAt[lte]string
generationDuration[between]string
generationDuration[gt]string
generationDuration[gte]string
generationDuration[lt]string
generationDuration[lte]string
generatorTopP[between]string
generatorTopP[gt]string
generatorTopP[gte]string
generatorTopP[lt]string
generatorTopP[lte]string
generatorTemperature[between]string
generatorTemperature[gt]string
generatorTemperature[gte]string
generatorTemperature[lt]string
generatorTemperature[lte]string
generatorScoring[between]string
generatorScoring[gt]string
generatorScoring[gte]string
generatorScoring[lt]string
generatorScoring[lte]string
curl -i -X GET \
  'https://api.askara.ai/documents?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Buuid%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5BencounteredAt%5D=asc&order%5BdataDeletedAt%5D=asc&order%5BverifiedAt%5D=asc&order%5BsentAt%5D=asc&order%5BgenerateStartedAt%5D=asc&order%5BgenerateEndedAt%5D=asc&order%5Btranscription%5D=asc&order%5BgenerateError%5D=asc&order%5BgenerationDuration%5D=asc&order%5BoriginalText%5D=asc&order%5Btext%5D=asc&order%5Bgenerator%5D=asc&order%5BgeneratorModel%5D=asc&order%5BgeneratorTopP%5D=asc&order%5BgeneratorTemperature%5D=asc&order%5BgeneratorScoring%5D=asc&order%5Btype%5D=asc&order%5BisAnonymized%5D=asc&expand%5B%5D=document.read_user&search=string&id=0&id%5B%5D=0&uuid=string&uuid%5B%5D=string&user.email=string&user.email%5B%5D=string&user.uuid=string&user.uuid%5B%5D=string&userSession=string&userSession%5B%5D=string&patient.email=string&patient.email%5B%5D=string&patient.uuid=string&patient.uuid%5B%5D=string&transcription=string&generateError=string&originalText=string&text=string&generator=string&generator%5B%5D=string&generatorModel=string&generatorModel%5B%5D=string&audio=string&audio%5B%5D=string&type=string&type%5B%5D=string&pdf=string&pdf%5B%5D=string&isAnonymized=true&isAnonymized%5B%5D=true&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&dataDeletedAt%5Bbetween%5D=string&dataDeletedAt%5Bgt%5D=string&dataDeletedAt%5Bgte%5D=string&dataDeletedAt%5Blt%5D=string&dataDeletedAt%5Blte%5D=string&verifiedAt%5Bbetween%5D=string&verifiedAt%5Bgt%5D=string&verifiedAt%5Bgte%5D=string&verifiedAt%5Blt%5D=string&verifiedAt%5Blte%5D=string&sentAt%5Bbetween%5D=string&sentAt%5Bgt%5D=string&sentAt%5Bgte%5D=string&sentAt%5Blt%5D=string&sentAt%5Blte%5D=string&generateStartedAt%5Bbetween%5D=string&generateStartedAt%5Bgt%5D=string&generateStartedAt%5Bgte%5D=string&generateStartedAt%5Blt%5D=string&generateStartedAt%5Blte%5D=string&generateEndedAt%5Bbetween%5D=string&generateEndedAt%5Bgt%5D=string&generateEndedAt%5Bgte%5D=string&generateEndedAt%5Blt%5D=string&generateEndedAt%5Blte%5D=string&generationDuration%5Bbetween%5D=string&generationDuration%5Bgt%5D=string&generationDuration%5Bgte%5D=string&generationDuration%5Blt%5D=string&generationDuration%5Blte%5D=string&generatorTopP%5Bbetween%5D=string&generatorTopP%5Bgt%5D=string&generatorTopP%5Bgte%5D=string&generatorTopP%5Blt%5D=string&generatorTopP%5Blte%5D=string&generatorTemperature%5Bbetween%5D=string&generatorTemperature%5Bgt%5D=string&generatorTemperature%5Bgte%5D=string&generatorTemperature%5Blt%5D=string&generatorTemperature%5Blte%5D=string&generatorScoring%5Bbetween%5D=string&generatorScoring%5Bgt%5D=string&generatorScoring%5Bgte%5D=string&generatorScoring%5Blt%5D=string&generatorScoring%5Blte%5D=string'

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.

verifiedAtstring or null(date-time)

Document verification date.

userstring(iri-reference)

Document author.

Example: "https://example.com/"
patientstring(iri-reference)

Document patient.

Example: "https://example.com/"
generationDurationinteger or null

Document generation duration.

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.list_pdf.list (object) or null

Document PDF file.

Any of:

Document PDF file.

isAnonymizedboolean

Document anonymization status.

Default false
Example: 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",
    "verifiedAt": "2019-08-24T14:15:22Z",
    "user": "https://example.com/",
    "patient": "https://example.com/",
    "generationDuration": 0,
    "type": "operative_report",
    "pdf": { … },
    "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.

verifiedAtstring or null(date-time)

Document verification date.

generateStartedAtstring or null(date-time)

Document generation start date.

generateEndedAtstring or null(date-time)

Document generation end date.

userobject(User-document.read_document.read_integrations_document.read_patient_document.read_user_document.read_pdf_pdf.list)

Document author.

patientobject(Patient-document.read_document.read_integrations_document.read_patient_document.read_user_document.read_pdf_pdf.list)

Document patient.

generationDurationinteger or null

Document generation duration.

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_document.read_user_document.read_pdf_pdf.list (object) or null

Document PDF file.

Any of:

Document PDF file.

isAnonymizedboolean

Document anonymization status.

Default false
Example: 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",
  "verifiedAt": "2019-08-24T14:15:22Z",
  "generateStartedAt": "2019-08-24T14:15:22Z",
  "generateEndedAt": "2019-08-24T14:15:22Z",
  "user": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "email": "user@example.com",
    "firstName": "string",
    "lastName": "string",
    "isVerified": false,
    "phone": "+33757590893",
    "rpps": "10101748050",
    "am": "394003552"
  },
  "patient": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "firstName": "string",
    "lastName": "string",
    "languageSpoken": "string",
    "dateOfBirth": "2019-08-24T14:15:22Z",
    "gender": "unknown",
    "externalId": "string",
    "externalCreatedAt": "2019-08-24T14:15:22Z",
    "email": "user@example.com",
    "phone": "+33757590893",
    "anonymousCode": "string",
    "externalSource": "string"
  },
  "generationDuration": 0,
  "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

Operations

Patient

Operations

User

Operations

Webhook

Operations