Contextual Pub/Sub

This endpoint allows subscribers to listen for data that matches specific criteria defined semantically (using natural language queries) across various indexes. It supports complex queries, including filtering and sorting, to fine-tune the data stream received.

Request Body Schema

To use this endpoint, send a POST request with a JSON payload containing the following fields:

Property	Type	Description
indexIds	array[indexId]	Array of indexes to be queried.
query	string	The query string or question to be answered.
filters	object	Filter object to add additional filters using metadata.
sort	string	Sorting column
page	number	Page number
skip	number	Skip offset

Endpoints

This section provides details about the available API endpoints.

Semantic Listener

POSThttps://dev.index.network/api/discovery/listen

Body

application/json

indexIds*array of string

query*string

pageinteger

skipinteger

filtersobject

modelstring

sortstring

descboolean

Response

200

OK

Body

application/stream+json

messagestring

timestampstring (date-time)

Request

JavaScriptCurl

const response = await fetch('https://dev.index.network/api/discovery/listen', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "indexIds": [
        "text"
      ],
      "query": "text"
    }),
});
const data = await response.json();

Response

{
  "message": "text",
  "timestamp": "2024-05-09T04:07:45.054Z"
}