Skip to main content
The read half of artifacts. Takes the artifact_id from a card’s metadata.artifact_id, surfaced by a normal recall call.

​
Parameters

​
string
required
From a recall result’s metadata.artifact_id.
​
'text' | 'url'
default:"text"
text returns the contents, paginated. url returns a presigned download link instead.
​
integer
default:"0"
Character offset to continue reading from. Used with mode: "text".

​
mode: "text" (default)

Returns the contents one page at a time. Page size is 51,200 characters.
Continue by passing the next offset:
Binary artifacts — PDFs, Office documents, images — return {"artifact_id": "...", "title": "...", "kind": "...", "error": "not_text"} rather than an extraction attempt. Klio does no text extraction from binary formats in this version; use mode: "url" to download and read them yourself.

​
mode: "url"

Returns a presigned download link.
The link is valid for 900 seconds and forces a download (Content-Disposition: attachment) rather than rendering inline — including for content types a browser would otherwise open directly, like PDFs or images.

​
Notes

A page is capped at 51,200 characters regardless of how large the underlying artifact is. A multi-megabyte document takes several calls with increasing offset to read in full — has_more tells you whether another page remains.
mode: "text" works for plain text, JSON, XML, and YAML content. PDFs, Word and Excel files, and images are not extracted — mode: "text" on one of these returns not_text, and mode: "url" is the only way to retrieve it.