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",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userId": "<string>",
      "patientId": "<string>",
      "summaryTemplateId": "<string>",
      "content": "<string>",
      "memoryBlockIds": [
        "<string>"
      ]
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "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
required

The page number to retrieve.

Required range: 0 <= x <= 9007199254740991
perPage
integer
default:20
required

The number of summary templates per page.

Required range: x <= 9007199254740991
patientId
string

The patient id to filter summaries by.

summaryTemplateId
string

The summary template id to filter summaries by.

Response

200 - application/json

Successful response

data
object[]
required

The list of items.

meta
object
required