Skip to main content
GET
/
ai
/
v1
/
summaries
List summaries
curl --request GET \
  --url https://api.{workspaceId}.clinia.cloud/ai/v1/summaries
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "patientId": "<string>",
      "summaryTemplateId": "<string>",
      "content": "<string>"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "perPage": 123
  }
}

Headers

x-user-id
string

The ID of the user making the request. Used to associate the request with a specific user.

Query Parameters

page
integer
default:0

The page number to retrieve.

Required range: x >= 0
perPage
integer
default:20

The number of elements per page.

patientId
string

The patient id to filter summaries by.

summaryTemplateId
string

The summary template id to filter summaries by.

Response

List of summaries

data
object[]
required

The list of items.

meta
object
required