Skip to main content
POST

Overview

Upload one or more vectors to a vector namespace. Each vector length must match the namespace vector_dimension set at creation. The upload runs asynchronously. Poll Upload job status with the returned job_id.
Any extra fields on each vector object (for example source, category) are stored as metadata and can be used in search filters.

Path parameters

string
required
Target vector namespace.

Headers

string
required
Must be application/json

Body

array
required
Non-empty array of vector objects.
string
required
Item id, unique within this namespace.
array
required
Array of finite numbers. Length must equal the namespace vector_dimension.
any
Optional additional keys on each vector are saved as metadata (for example "source": "demo").
The vector array length must match vector_dimension for my-embeddings (for example 768 or 5 depending on how the namespace was created).

Response fields

string
Request outcome. "success" when the upload job was started; "failure" on error.
string
Human-readable result or error description.
string
Id of the async upload job. Poll Upload job status with this value. Present when the upload job was started.
string
Namespace the vectors are being uploaded to. Present when the upload job was started.
number
Number of vectors accepted into the upload job. Present when the upload job was started.
number
Current total item count on the instance. Present on 409 item limit errors.
number
Global item cap for this instance. Present on 409 item limit errors.
number
Number of new item ids in the request that would exceed the cap. Present on 409 item limit errors.

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
  • Vector values must be finite (no NaN or Infinity)

Next Steps