Skip to main content
Batch operations allow you to perform multiple operations in a single request, significantly improving throughput and reducing network overhead.

Batch Insert/Upsert

Insert or update multiple points in a single request.

API Endpoint

The batch format is more efficient for large uploads as it avoids repeating field names.

Batch Update Operations

Perform multiple update operations (upsert, delete, update payload, etc.) in a single request.

API Endpoint

Supported Operations

object
Insert or update points.
object
Delete points by IDs or filter.
object
Set or merge payload for specified points.
object
Replace entire payload for specified points.
object
Delete specific payload fields.
object
Remove all payload from specified points.
object
Update vectors for existing points.
object
Delete specific named vectors.

Batch Delete

Delete multiple points at once.

API Endpoint

Delete by IDs

Delete by Filter

Delete all points matching a filter condition.
Deleting by filter can affect many points. Use with caution in production environments.

Scroll API - Iterate Through Points

The scroll API allows you to iterate through all points in a collection, which is useful for exporting data or processing large datasets.

API Endpoint

Scroll Parameters

integer | string
Start scrolling from this offset. Use the next_page_offset from the previous response.
integer
default:"10"
Maximum number of points to return per request.
boolean | array
default:"true"
Include payload in results. Can be true, false, or array of specific fields.
boolean | array
default:"false"
Include vectors in results.
object
Filter conditions to apply during scrolling.

Paginate Through All Points

Scroll with Filters

Response Format

Batch Upsert Response

Batch Update Response

Scroll Response

array
Array of retrieved points.
integer | null
Offset for the next page. null means no more points.

Query Parameters

boolean
default:"true"
Wait for the operation to complete before returning.
string
Ordering guarantees: weak, medium, or strong.
integer
Operation timeout in seconds.

Best Practices

  1. Batch Size: Use batch sizes of 100-1000 points for optimal performance
  2. Wait Parameter: Set wait=false for bulk operations to improve throughput
  3. Scroll Limit: Keep scroll limit reasonable (100-1000) to balance memory and network
  4. Error Handling: Implement retry logic for failed batch operations
  5. Memory Management: Process scroll results in chunks to avoid memory issues
  6. Parallel Processing: For very large datasets, consider parallel scroll operations with filters
Batch operations are atomic - either all operations succeed or all fail.