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."
}
Items
Get Items by ID
Retrieve items by id within a namespace (up to 100 ids per request).
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, andmetadatafor each found item - Vector namespaces return
idandmetadataonly (vectors are not returned)
items; the request still returns 200 with found_items less than requested_ids.
Path parameters
Headers
Body
curl -X POST "http://localhost:8080/namespaces/my-documents/items/get" \
-H "Content-Type: application/json" \
-d '{
"ids": ["doc-1", "doc-2"]
}'
Response fields
Number of items returned in
items. May be less than requested_ids if some ids were not found. Present on successful lookup.Array of found items. Empty array when none of the requested ids exist. Present on successful lookup.
{
"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_itemsvsrequested_ids - Vector embeddings are not included in the response
Related
Was this page helpful?