Stream a rendered PDF page image
/resources/{ref}/pages/{pdfPage}Returns JPEG bytes for a pre-rendered page of the resource's PDF (rendered during vector indexing). Useful for showing the exact page a search hit or AI citation points at.
Two ways to authenticate:
X-Api-Keyheader (read scope) — for server-side fetches.- Signed URL (
exp+sigquery params) — time-limited HMAC signature, so the URL can be embedded directly in a browser<img src>without exposing the api-key. Signed page URLs are issued by the AI chat response when a citation references a page.
Authorization
apiKey Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.
In: header
Path Parameters
Resource ref.
1-based PDF page number.
1 <= valueQuery Parameters
Signed-URL expiry (unix timestamp). Only with sig.
HMAC signature for browser-embeddable access.
Response Body
image/jpeg
application/json
application/json
curl -X GET "https://example.com/resources/0/pages/1""string"{ "success": false, "status": "fail", "message": "string", "error": { "message": "API key is required", "code": "NO_API_KEY" }}{ "success": false, "status": "fail", "message": "string", "error": { "message": "API key is required", "code": "NO_API_KEY" }}Get a resource's extracted full text (paginated) GET
Returns a resource's extracted full text, paginated by character. This is the direct-REST door for the AI chat's `document_read` tool (full content) and reads the same extracted-text source — a big enabler for external RAG, since a caller can pull the text and chunk/embed it themselves. Page with either `offset` (0-based character offset) or `page` (1-based; `offset = (page - 1) * limit`). When both are present, `offset` wins. `total` is the full extracted-text length; `hasMore` is true while further pages remain. A resource that exists and is visible but has no extracted text yet returns `200` with `total: 0` and empty `content` — not a 404. Not-found and no-view-access both return `404 NOT_FOUND` so the surface never reveals which refs exist in other usergroups.
Stream preview image bytes GET
Returns JPEG bytes for the requested preview size.