Skip to main content
POST
memory.document.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
namespace
string
required

Which set of documents to work on: an id you choose per user, project or tenant (letters, digits, "_", ":", "-", at most 83 characters). Use the same value across the memory capabilities.

Required string length: 1 - 83
Pattern: ^[a-zA-Z0-9_:-]+$
id
string

The document's caller-supplied id, as you passed it to memory.document.add. Send id or ref.

Required string length: 1 - 255
ref
string

The ref returned by memory.document.add.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
enum<string>
required

The document's processing state.

Available options:
unknown,
queued,
extracting,
chunking,
embedding,
indexing,
done,
failed
id
string

The document's id, when you supplied one to memory.document.add.

title
string

Extracted or supplied title.

summary
string

Short generated summary of the document.

createdAt
string

When the document was added, ISO 8601.

updatedAt
string

When the document last changed, ISO 8601.

metadata
object

The metadata attached to the document when it was added.

content
string

The document's extracted text, when it has been processed.