Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Documents

The `documents` collection of Sylphx Data.

The documents collection of Sylphx Data — served at https://api.data.sylphx.com.

Service Sylphx Data · served at https://api.data.sylphx.com

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
PUTputWrites a document to a search index, replacing the current version.
GETgetReads a document.
DELETEdeleteDeletes a document.

#put

Writes a document to a search index, replacing the current version.

PUT https://api.data.sylphx.com/v1/documents/index-id/document-id · scope data:write · effect write · Request, response and examples

#get

Reads a document.

GET https://api.data.sylphx.com/v1/documents/index-id/document-id · scope data:read · effect read · Request, response and examples

#delete

Deletes a document.

DELETE https://api.data.sylphx.com/v1/documents/index-id/document-id · scope data:write · effect destructive · Request, response and examples