Get Items by ID

curl -X POST "http://localhost:8080/namespaces/my-documents/items/get" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["doc-1", "doc-2"]
  }'

{
  "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": "Moorcheh on-prem retrieval test"
    }
  ]
}

{
  "status": "success",
  "message": "Successfully retrieved 1 items from namespace 'my-embeddings'.",
  "requested_ids": 1,
  "found_items": 1,
  "items": [
    {
      "id": "vec-1",
      "metadata": { "source": "demo" }
    }
  ]
}

{
  "status": "success",
  "message": "Successfully retrieved 0 items from namespace 'my-documents'.",
  "requested_ids": 1,
  "found_items": 0,
  "items": []
}

{
  "status": "failure",
  "message": "Bad Request: ids must be a non-empty array."
}

{
  "status": "failure",
  "message": "Bad Request: at most 100 ids are allowed per get request."
}

{
  "status": "failure",
  "message": "Bad Request: each id must be a non-empty string."
}

{
  "status": "failure",
  "message": "Namespace 'my-documents' not found."
}

{
  "status": "failure",
  "message": "Internal Server Error retrieving namespace items."
}

POST

namespaces

{namespace_name}

items

get

curl -X POST "http://localhost:8080/namespaces/my-documents/items/get" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["doc-1", "doc-2"]
  }'

{
  "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": "Moorcheh on-prem retrieval test"
    }
  ]
}

{
  "status": "success",
  "message": "Successfully retrieved 1 items from namespace 'my-embeddings'.",
  "requested_ids": 1,
  "found_items": 1,
  "items": [
    {
      "id": "vec-1",
      "metadata": { "source": "demo" }
    }
  ]
}

{
  "status": "success",
  "message": "Successfully retrieved 0 items from namespace 'my-documents'.",
  "requested_ids": 1,
  "found_items": 0,
  "items": []
}

{
  "status": "failure",
  "message": "Bad Request: ids must be a non-empty array."
}

{
  "status": "failure",
  "message": "Bad Request: at most 100 ids are allowed per get request."
}

{
  "status": "failure",
  "message": "Bad Request: each id must be a non-empty string."
}

{
  "status": "failure",
  "message": "Namespace 'my-documents' not found."
}

{
  "status": "failure",
  "message": "Internal Server Error retrieving namespace items."
}

Overview

Fetch stored items by id within a namespace. Item ids are unique per namespace, not globally.

Text namespaces return id, text, and metadata for each found item
Vector namespaces return id and metadata only (vectors are not returned)

Ids that do not exist are omitted from items; the request still returns 200 with found_items less than requested_ids.

Path parameters

string

required

Namespace to read from.

Headers

string

required

Must be application/json

Body

array

required

Non-empty array of item id strings. Maximum 100 ids per request.

curl -X POST "http://localhost:8080/namespaces/my-documents/items/get" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["doc-1", "doc-2"]
  }'

Response fields

string

Request outcome. "success" when the lookup completed; "failure" on error.

string

Human-readable result or error description.

number

Number of ids sent in the request. Present on successful lookup.

number

Number of items returned in items. May be less than requested_ids if some ids were not found. Present on successful lookup.

array

Array of found items. Empty array when none of the requested ids exist. Present on successful lookup.

string

Item id.

string

Stored document text. Present for text namespace items only.

object

Metadata stored with the item (custom fields from upload).

{
  "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": "Moorcheh on-prem retrieval test"
    }
  ]
}

{
  "status": "success",
  "message": "Successfully retrieved 1 items from namespace 'my-embeddings'.",
  "requested_ids": 1,
  "found_items": 1,
  "items": [
    {
      "id": "vec-1",
      "metadata": { "source": "demo" }
    }
  ]
}

{
  "status": "success",
  "message": "Successfully retrieved 0 items from namespace 'my-documents'.",
  "requested_ids": 1,
  "found_items": 0,
  "items": []
}

{
  "status": "failure",
  "message": "Bad Request: ids must be a non-empty array."
}

{
  "status": "failure",
  "message": "Bad Request: at most 100 ids are allowed per get request."
}

{
  "status": "failure",
  "message": "Bad Request: each id must be a non-empty string."
}

{
  "status": "failure",
  "message": "Namespace 'my-documents' not found."
}

{
  "status": "failure",
  "message": "Internal Server Error retrieving namespace items."
}

Important Notes

Maximum 100 ids per request — use multiple requests for larger batches
Missing ids are skipped; check found_items vs requested_ids
Vector embeddings are not included in the response

System

Namespace Management

Search

AI Generation

Data Operations

File storage

Items

Overview

Path parameters

Headers

Body

Response fields

Important Notes

​Overview

​Path parameters

​Headers

​Body

​Response fields

​Important Notes

​Related

Overview

Path parameters

Headers

Body

Response fields

Important Notes

Related