GoodMemGoodMem
ReferenceAPIREST APIMemories

Download memory page image content

GET /v1/memories/{id}/pages/{pageIndex}/image: Downloads inline bytes for one page image.

GET
/v1/memories/{id}/pages/{pageIndex}/image

Downloads inline bytes for one page image. The page index is required. The optional dpi and content type query parameters act as rendition filters; if omitted, the server returns the unique rendition for that page or rejects ambiguous matches. 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

pageIndex*integer

0-based page index

Formatint32

Query Parameters

dpi?integer

Optional rendition filter. If omitted, the unique page-image rendition for the page is returned; if multiple renditions exist, specify dpi and/or contentType.

Formatint32
contentType?string

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

Header Parameters

Range?string

Single byte range, for example bytes=1024-

Accept-Encoding?string

Use identity to receive a strong ETag for conditional downloads

If-Match?string

Saved strong ETag, including quotes. A mismatch returns 412

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 content streamed successfully

response?fileapplication/octet-stream
Formatbinary
Example Request
curl -X GET 'https://your-goodmem-server.example.com/v1/memories/550e8400-e29b-41d4-a716-446655440000/pages/0/image?dpi=150&contentType=image%2Fpng' \  -H 'GoodMem-Timeout-Ms: 30000'
Example Response
"string"