Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Localization
Monitoring
Notifications
Payments
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
Patch in Documents
Changes some fields of a document and keeps the rest: a JSON merge patch (RFC 7396).
Changes some fields of a document and keeps the rest: a JSON merge patch (RFC 7396). The version goes up by one.
- Path
PATCH https://api.data.sylphx.com/v1/documents/index-id/document-id - Scope
data:write - Effect
write— a successful call changes state. - Collection documents
- Host
https://api.data.sylphx.com
#Request
| Field | Type | What it is |
|---|---|---|
index_id | string | The search index's id. Required. |
document_id | string | The document's id; the document must exist. Required. |
patch_json | bytes | A JSON object, base64; at most 1 MiB. A field set to a value replaces that field, an object merges into the stored object field by field, and null removes the field. Required. |
vector | double[] | A new embedding; empty keeps the stored one. |
expected_version | uint64 | Write only when the current version equals this one (0: any). |
#Response
| Field | Type | What it is |
|---|---|---|
document | DocumentRecord | The stored document. |
#DocumentRecord
| Field | Type | What it is |
|---|---|---|
index_id | string | The search index's id in the environment, for example articles. |
document_id | string | The document's id. |
document_json | bytes | The document as JSON, base64. |
vector | double[] | The document's embedding; its length is the index's vector dimensions. |
sha256 | string | sha256:<hex> of the document. |
version | uint64 | The version, increasing per document. |
updated_at_unix_ms | int64 | When this version was written, in Unix milliseconds. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.
Every error arrives in the body Errors describes.
#Examples
curl -X PATCH "https://api.data.sylphx.com/v1/documents/index-id/document-id" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"patch_json":"…"}'