Skip to main content
POST
/
namespaces
/
{namespace_name}
/
documents
curl -X POST "http://localhost:8080/namespaces/my-documents/documents" \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [
      {
        "id": "doc-1",
        "text": "Moorcheh on-prem retrieval test",
        "team": "ai"
      }
    ]
  }'

{
  "status": "success",
  "message": "Documents upload started. Poll job status for progress.",
  "job_id": "job-a0e3d54b9d0d4616949474697308a39c",
  "namespace_name": "my-documents",
  "total": 1
}

​
Overview

Upload one or more documents to a text namespace. Each document is embedded with the configured Ollama model and stored for semantic search. The upload runs asynchronously. Poll Upload job status with the returned job_id.
Any extra fields on each document object (for example team, source) are stored as metadata and can be used in search filters.

​
Path parameters

​
namespace_name
string
required
Target text namespace.

​
Headers

​
Content-Type
string
required
Must be application/json

​
Body

​
documents
array
required
Non-empty array of document objects.
​
documents[].id
string
required
Item id, unique within this namespace.
​
documents[].text
string
required
Document text to embed and store.
​
documents[].{metadata}
any
Optional additional keys on each document are saved as metadata (for example "team": "ai").
curl -X POST "http://localhost:8080/namespaces/my-documents/documents" \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [
      {
        "id": "doc-1",
        "text": "Moorcheh on-prem retrieval test",
        "team": "ai"
      }
    ]
  }'

​
Response fields

​
status
string
Request outcome. "success" when the upload job was started; "failure" on error.
​
message
string
Human-readable result or error description.
​
job_id
string
Id of the async upload job. Poll Upload job status with this value. Present when the upload job was started.
​
namespace_name
string
Namespace the documents are being uploaded to. Present when the upload job was started.
​
total
number
Number of documents accepted into the upload job. Present when the upload job was started.
​
items
number
Current total item count on the instance. Present on 409 item limit errors.
​
max_items
number
Global item cap for this instance. Present on 409 item limit errors.
​
requested_new
number
Number of new item ids in the request that would exceed the cap. Present on 409 item limit errors.
{
  "status": "success",
  "message": "Documents upload started. Poll job status for progress.",
  "job_id": "job-a0e3d54b9d0d4616949474697308a39c",
  "namespace_name": "my-documents",
  "total": 1
}

​
Important Notes

  • At most 100,000 items total across all namespaces
  • 409 is returned before the job starts if new ids would exceed the cap
  • Re-uploading an existing id in the same namespace updates the item and does not consume extra quota

​
Next Steps