GoodMem
ReferenceAPIREST APIMemories

List memory page images

Lists extracted page-image metadata for a memory with optional filters and pagination.

GET
/v1/memories/{id}/pages
x-api-key<token>

In: header

Path Parameters

idstring

Memory UUID

Query Parameters

startPageIndex?integer

Optional lower bound for returned page indices, inclusive. The snake_case alias start_page_index is also accepted.

Formatint32
endPageIndex?integer

Optional upper bound for returned page indices, inclusive. The snake_case alias end_page_index is also accepted.

Formatint32
dpi?integer

Optional rendition filter for page-image DPI.

Formatint32
contentType?string

Optional rendition filter for page-image MIME type, such as image/png. The snake_case alias content_type is also accepted.

maxResults?integer

Maximum number of results per page. The snake_case alias max_results is also accepted.

Formatint32
nextToken?string

Opaque pagination token for the next page. The snake_case alias next_token is also accepted. Do not parse or construct it.

Response Body

curl -X GET "http://localhost:8080/v1/memories/550e8400-e29b-41d4-a716-446655440000/pages?startPageIndex=0&endPageIndex=10&dpi=150&contentType=image%2Fpng&maxResults=50&nextToken=eyJzdGFydCI6NTAsIm1lbW9yeUlkIjoiLi4uIn0"
{
  "pageImages": [
    {
      "memoryId": "550e8400-e29b-41d4-a716-446655440000",
      "pageIndex": 0,
      "dpi": 150,
      "contentType": "image/png",
      "imageContentLength": 281233,
      "imageContentSha256": "2d711642b726b04401627ca9fbac32f5c8530fb1903cc4db02258717921a4881",
      "createdAt": 1714762260000,
      "updatedAt": 1714762260000,
      "createdById": "550e8400-e29b-41d4-a716-446655440001",
      "updatedById": "550e8400-e29b-41d4-a716-446655440001"
    }
  ],
  "nextToken": "string"
}
Empty
Empty
Empty
Empty