Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.moorcheh.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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

moorcheh items-get --namespace-name NAME --ids-json '["id1","id2"]' [--base-url URL]

​
Options

FlagRequiredDescription
--namespace-nameYesNamespace to read from
--ids-jsonYesJSON array of item id strings (max 100 per request)
--base-urlNoDefault http://localhost:8080
On Windows PowerShell, escape inner quotes: --ids-json '[\"doc-1\",\"doc-2\"]'. In bash, use single quotes: '["doc-1","doc-2"]'.

​
Examples

moorcheh items-get --namespace-name my-documents --ids-json '["doc-1","doc-2"]'

moorcheh items-get --namespace-name my-embeddings --ids-json '["vec-1"]'

​
Output

Prints JSON from POST /namespaces/{namespace_name}/items/get:
​
status
string
"success" when the lookup completed; "failure" on error.
​
message
string
Human-readable result or error description.
​
requested_ids
number
Number of ids sent in the request.
​
found_items
number
Number of items returned in items.
​
items
array
Found items. Empty when none of the ids exist.
​
items[].id
string
Item id.
​
items[].text
string
Document text. Present for text namespace items only.
​
items[].metadata
object
Metadata stored with the item.
Example output (text namespace)
{
  "status": "success",
  "message": "Successfully retrieved 1 items from namespace 'my-documents'.",
  "requested_ids": 2,
  "found_items": 1,
  "items": [
    {
      "id": "doc-1",
      "metadata": { "team": "ai" },
      "text": "CLI upload documents test"
    }
  ]
}
Example output (vector namespace)
{
  "status": "success",
  "message": "Successfully retrieved 1 items from namespace 'my-embeddings'.",
  "requested_ids": 1,
  "found_items": 1,
  "items": [
    {
      "id": "vec-1",
      "metadata": { "source": "demo" }
    }
  ]
}

​
Exit codes

CodeMeaning
0Lookup completed (including when no ids were found)
1API error (400, 404, 500, etc.) or invalid --ids-json