curl --request POST \
  --url https://semantik.noetive.io/v1/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "MATCH DISTANCE(\"gpu shortage\") WITHIN 0.5",
  "namespace": "global",
  "model": "Qwen3-Embedding-4B",
  "dimensions": 1024
}
'

import requests

url = "https://semantik.noetive.io/v1/subscribe"

payload = {
    "query": "MATCH DISTANCE(\"gpu shortage\") WITHIN 0.5",
    "namespace": "global",
    "model": "Qwen3-Embedding-4B",
    "dimensions": 1024
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: 'MATCH DISTANCE("gpu shortage") WITHIN 0.5',
    namespace: 'global',
    model: 'Qwen3-Embedding-4B',
    dimensions: 1024
  })
};

fetch('https://semantik.noetive.io/v1/subscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://semantik.noetive.io/v1/subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => 'MATCH DISTANCE("gpu shortage") WITHIN 0.5',
    'namespace' => 'global',
    'model' => 'Qwen3-Embedding-4B',
    'dimensions' => 1024
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://semantik.noetive.io/v1/subscribe"

	payload := strings.NewReader("{\n  \"query\": \"MATCH DISTANCE(\\\"gpu shortage\\\") WITHIN 0.5\",\n  \"namespace\": \"global\",\n  \"model\": \"Qwen3-Embedding-4B\",\n  \"dimensions\": 1024\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://semantik.noetive.io/v1/subscribe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"MATCH DISTANCE(\\\"gpu shortage\\\") WITHIN 0.5\",\n  \"namespace\": \"global\",\n  \"model\": \"Qwen3-Embedding-4B\",\n  \"dimensions\": 1024\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semantik.noetive.io/v1/subscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"MATCH DISTANCE(\\\"gpu shortage\\\") WITHIN 0.5\",\n  \"namespace\": \"global\",\n  \"model\": \"Qwen3-Embedding-4B\",\n  \"dimensions\": 1024\n}"

response = http.request(request)
puts response.read_body

"<string>"

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

Endpoints

Register a persistent subscription and open an SSE match stream

Compiles the SemQL query, registers a persistent subscription, and returns a Server-Sent Events stream of match notifications.

The stream begins with a subscribed event whose data is a SubscribedEvent JSON object. Subsequent match events carry a MatchEvent JSON object. The subscription is removed automatically when the client disconnects.

Example SSE frames:

event: subscribed
data: {"subscription_id":"sub_8f2c..."}

event: match
data: {"message_id":"msg_7a21de40f1b2c493","score":0.82}

Requires Content-Type: application/json.

POST

curl --request POST \
  --url https://semantik.noetive.io/v1/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "MATCH DISTANCE(\"gpu shortage\") WITHIN 0.5",
  "namespace": "global",
  "model": "Qwen3-Embedding-4B",
  "dimensions": 1024
}
'

import requests

url = "https://semantik.noetive.io/v1/subscribe"

payload = {
    "query": "MATCH DISTANCE(\"gpu shortage\") WITHIN 0.5",
    "namespace": "global",
    "model": "Qwen3-Embedding-4B",
    "dimensions": 1024
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: 'MATCH DISTANCE("gpu shortage") WITHIN 0.5',
    namespace: 'global',
    model: 'Qwen3-Embedding-4B',
    dimensions: 1024
  })
};

fetch('https://semantik.noetive.io/v1/subscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://semantik.noetive.io/v1/subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => 'MATCH DISTANCE("gpu shortage") WITHIN 0.5',
    'namespace' => 'global',
    'model' => 'Qwen3-Embedding-4B',
    'dimensions' => 1024
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://semantik.noetive.io/v1/subscribe"

	payload := strings.NewReader("{\n  \"query\": \"MATCH DISTANCE(\\\"gpu shortage\\\") WITHIN 0.5\",\n  \"namespace\": \"global\",\n  \"model\": \"Qwen3-Embedding-4B\",\n  \"dimensions\": 1024\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://semantik.noetive.io/v1/subscribe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"MATCH DISTANCE(\\\"gpu shortage\\\") WITHIN 0.5\",\n  \"namespace\": \"global\",\n  \"model\": \"Qwen3-Embedding-4B\",\n  \"dimensions\": 1024\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semantik.noetive.io/v1/subscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"MATCH DISTANCE(\\\"gpu shortage\\\") WITHIN 0.5\",\n  \"namespace\": \"global\",\n  \"model\": \"Qwen3-Embedding-4B\",\n  \"dimensions\": 1024\n}"

response = http.request(request)
puts response.read_body

"<string>"

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>",
  "retry_after_ms": 123
}

Authorizations

Authorization

string

header

required

API key bearer token. Obtain from the Noetive dashboard. Pass as: Authorization: Bearer <api-key>.

Body

application/json

query

string

required

SemQL query text for subscription matching. Subject to the SemQL query limits — see the "SemQL query limits" section in the API description.

Two clause shapes are rejected here that /v1/search accepts: a query with no DISTANCE, DIRECTION or CONTRAST clause (it would deliver the namespace's entire stream), and any use of TOP (it ranks within a result set, and a stream has none — use WITHIN instead). Both return 400 invalid_request.

namespace

string

required

Target namespace alias — a registered name (e.g. articles) or the well-known global alias. Required; there is no default. Every request is validated against the namespace's configured model and dimensions; a mismatch returns 400 invalid_request.

Pass the alias, not the ns_... identifier shown in the dashboard — a raw identifier is rejected with 400 invalid_request.

Maximum string length: 64

Pattern: ^[A-Za-z0-9_-]+$

model

string

required

Embedding model name. Required; there is no default. Must match the model configured on the namespace, or the request fails with 400 model_not_provisioned.

dimensions

integer

required

Embedding vector dimensionality. Required; there is no default. Must match the dimensionality configured on the namespace for model, or the request fails with 400 model_not_provisioned.

Required range: 1 <= x <= 4096

Response

SSE stream of match events. Content-Type: text/event-stream.

First event: event: subscribed, data is a SubscribedEvent.
Subsequent events: event: match, data is a MatchEvent.

Raw SSE stream. Payload schemas for each event type are SubscribedEvent and MatchEvent.