Sign in

v38

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31148285.5 KB

Create, update, or delete documents.

post/v2/namespaces/{namespace}

Path parameters

namespacestring required

The name of the namespace.

Request body

{"stackTrail":"components:schemas:Write:properties:upsert_condition","oasType":"schema","type":"unknown","description":"A condition evaluated against the current value of each document targeted by an upsert write. Only documents that pass the condition are upserted.\n","extensionFields":{"x-stainless-any":true}}
{"stackTrail":"components:schemas:Write:properties:patch_condition","oasType":"schema","type":"unknown","description":"A condition evaluated against the current value of each document targeted by a patch write. Only documents that pass the condition are patched.\n","extensionFields":{"x-stainless-any":true}}
{"stackTrail":"components:schemas:Write:properties:delete_condition","oasType":"schema","type":"unknown","description":"A condition evaluated against the current value of each document targeted by a delete write. Only documents that pass the condition are deleted.\n","extensionFields":{"x-stainless-any":true}}
schemaobject

The schema of the attributes attached to the documents.

{"stackTrail":"components:schemas:Write:properties:delete_by_filter","oasType":"schema","type":"unknown","description":"The filter specifying which documents to delete.","extensionFields":{"x-stainless-any":true}}
delete_by_filter_allow_partialboolean

Allow partial completion when filter matches too many documents.

patch_by_filter_allow_partialboolean

Allow partial completion when filter matches too many documents.

return_affected_idsboolean

If true, return the IDs of affected rows (deleted, patched, upserted) in the response. For filtered and conditional writes, only IDs for writes that succeeded will be included.

disable_backpressureboolean

Disables write throttling (HTTP 429 responses) during high-volume ingestion.

Response

The status of the request.

status'OK' required

The status of the request.

messagestring required

A message describing the result of the write request.

rows_affectedinteger required

The number of rows affected by the write request.

rows_upsertedinteger

The number of rows upserted by the write request.

rows_patchedinteger

The number of rows patched by the write request.

rows_deletedinteger

The number of rows deleted by the write request.

rows_remainingboolean

Whether more documents match the filter for partial operations.