Back to explore

storage

Search

Credits: 0.000001

Create Index

POST /v1/search/CreateIndex

Create an index by name

Request

indexstring

The name of the index

Response

{}

Request

Response

{}

Credits: 0.000001

Delete

POST /v1/search/Delete

Delete a record given its ID

Request

idstring

The ID of the record to delete

indexstring

The index the record belongs to

Response

{}

Request

Response

{}

Credits: 0.000001

Delete Index

POST /v1/search/DeleteIndex

Delete an index by name

Request

indexstring

The name of the index to delete

Response

{}

Request

Response

{}

Credits: 0.000001

Index

POST /v1/search/Index

Index a record i.e. insert a document to search for.

Request

dataobject

The data to index

idstring

Optional ID for the record

indexstring

The index this record belongs to

Response

recordobject

the indexed record

Request

Response

{
    "record": {
        "id": "0d5aab12-c716-4174-8c3a-f4222b337292",
        "data": {
            "name": "John Doe",
            "age": 37,
            "starsign": "Leo"
        }
    }
}