Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Delete in Documents
Deletes a document.
Deletes a document.
- Path
DELETE https://api.data.sylphx.com/v1/documents/index-id/document-id - Scope
data:write - Effect
destructive— a successful call removes data; the CLI asks before it runs. - Collection documents
- Query
expected_version - 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. Required. |
expected_version | uint64 | Delete only when the current version equals this one (0: any). |
#Response
| Field | Type | What it is |
|---|---|---|
deleted | bool | Whether the document existed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.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 DELETE "https://api.data.sylphx.com/v1/documents/index-id/document-id" \
-H "Authorization: Bearer $SYLPHX_API_KEY"