GoodMemGoodMem
ReferenceAPIREST APIMemories

List memory page images

GET /v1/memories/{id}/pages: Lists extracted page-image metadata for a memory with optional filters and pagination.

GET
/v1/memories/{id}/pages

Lists extracted page-image metadata for a memory with optional filters and pagination. Requires READ_MEMORY on the containing memory; authority may be granted through DIRECT_MEMBERS_OF its containing space.

Authorization

ApiKeyAuth
headerx-api-key<token>

Path Parameters

id*string

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.

Header Parameters

GoodMem-Timeout-Ms?integer

Optional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.

Formatint64
Range1 <= value <= 86400000

Response Body

Page-image metadata retrieved successfully

application/json
  1. response

Page of memory page-image metadata

pageImages*array<>

Page-image metadata rows

nextToken?|

Opaque token for retrieving the next page

Example Request
curl -X GET 'https://your-goodmem-server.example.com/v1/memories/550e8400-e29b-41d4-a716-446655440000/pages?startPageIndex=0&endPageIndex=10&dpi=150&contentType=image%2Fpng&maxResults=50&nextToken=eyJzdGFydCI6NTAsIm1lbW9yeUlkIjoiLi4uIn0' \  -H 'GoodMem-Timeout-Ms: 30000'
Example Response
{  "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"}