Skip to main content

Overview

Retrieves stored items by id within a namespace. Item ids are unique per namespace, not globally.
  • Text namespaces return id, text, and metadata
  • Vector namespaces return id and metadata only
Missing ids are omitted from items (still returns 200 with found_items less than requested_ids).

Synopsis

Options

On Windows PowerShell, escape inner quotes: --ids-json '[\"doc-1\",\"doc-2\"]'. In bash, use single quotes: '["doc-1","doc-2"]'.

Examples

Output

Prints JSON from POST /namespaces/{namespace_name}/items/get:
string
"success" when the lookup completed; "failure" on error.
string
Human-readable result or error description.
number
Number of ids sent in the request.
number
Number of items returned in items.
array
Found items. Empty when none of the ids exist.
string
Item id.
string
Document text. Present for text namespace items only.
object
Metadata stored with the item.
Example output (text namespace)
Example output (vector namespace)

Exit codes