Change a subscription's events, include, endpoint or bulk
curl --request PATCH \
--url https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [],
"include": {
"attributes": [
"<string>"
],
"answers": [
"<string>"
]
},
"endpoint": "<string>",
"bulk": "summary"
}
'import requests
url = "https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}"
payload = {
"events": [],
"include": {
"attributes": ["<string>"],
"answers": ["<string>"]
},
"endpoint": "<string>",
"bulk": "summary"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [],
include: {attributes: ['<string>'], answers: ['<string>']},
endpoint: '<string>',
bulk: 'summary'
})
};
fetch('https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}', 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://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
],
'include' => [
'attributes' => [
'<string>'
],
'answers' => [
'<string>'
]
],
'endpoint' => '<string>',
'bulk' => 'summary'
]),
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://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}"
payload := strings.NewReader("{\n \"events\": [],\n \"include\": {\n \"attributes\": [\n \"<string>\"\n ],\n \"answers\": [\n \"<string>\"\n ]\n },\n \"endpoint\": \"<string>\",\n \"bulk\": \"summary\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [],\n \"include\": {\n \"attributes\": [\n \"<string>\"\n ],\n \"answers\": [\n \"<string>\"\n ]\n },\n \"endpoint\": \"<string>\",\n \"bulk\": \"summary\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [],\n \"include\": {\n \"attributes\": [\n \"<string>\"\n ],\n \"answers\": [\n \"<string>\"\n ]\n },\n \"endpoint\": \"<string>\",\n \"bulk\": \"summary\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"filters": {
"[1]": "Eq"
},
"events": [
"entered"
],
"include": {
"attributes": [
"<string>"
],
"answers": [
"<string>"
]
},
"endpoint": "<string>",
"bulk": "summary",
"status": "syncing",
"live_at": "2023-11-07T05:31:56Z",
"lag_ms": 1,
"warnings": [
{
"code": "judgment_inactive",
"message": "<string>",
"judgment": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"template": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}Subscriptions
Change a subscription's events, include, endpoint or bulk
Changes events, include, endpoint and bulk, from the next
event on. filters never changes (invalid_request): a different
filter has no honest edges, so create a new subscription and delete
this one. A namespace cannot change a subscription it inherits
(conflict); change it on the template’s prefix path, which needs
templates (plan_required below Team). A new include or
endpoint is checked as on create.
PATCH
/
namespaces
/
{ns}
/
subscriptions
/
{name}
Change a subscription's events, include, endpoint or bulk
curl --request PATCH \
--url https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [],
"include": {
"attributes": [
"<string>"
],
"answers": [
"<string>"
]
},
"endpoint": "<string>",
"bulk": "summary"
}
'import requests
url = "https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}"
payload = {
"events": [],
"include": {
"attributes": ["<string>"],
"answers": ["<string>"]
},
"endpoint": "<string>",
"bulk": "summary"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: [],
include: {attributes: ['<string>'], answers: ['<string>']},
endpoint: '<string>',
bulk: 'summary'
})
};
fetch('https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}', 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://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
],
'include' => [
'attributes' => [
'<string>'
],
'answers' => [
'<string>'
]
],
'endpoint' => '<string>',
'bulk' => 'summary'
]),
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://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}"
payload := strings.NewReader("{\n \"events\": [],\n \"include\": {\n \"attributes\": [\n \"<string>\"\n ],\n \"answers\": [\n \"<string>\"\n ]\n },\n \"endpoint\": \"<string>\",\n \"bulk\": \"summary\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [],\n \"include\": {\n \"attributes\": [\n \"<string>\"\n ],\n \"answers\": [\n \"<string>\"\n ]\n },\n \"endpoint\": \"<string>\",\n \"bulk\": \"summary\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vainona.ai/v1/namespaces/{ns}/subscriptions/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [],\n \"include\": {\n \"attributes\": [\n \"<string>\"\n ],\n \"answers\": [\n \"<string>\"\n ]\n },\n \"endpoint\": \"<string>\",\n \"bulk\": \"summary\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"filters": {
"[1]": "Eq"
},
"events": [
"entered"
],
"include": {
"attributes": [
"<string>"
],
"answers": [
"<string>"
]
},
"endpoint": "<string>",
"bulk": "summary",
"status": "syncing",
"live_at": "2023-11-07T05:31:56Z",
"lag_ms": 1,
"warnings": [
{
"code": "judgment_inactive",
"message": "<string>",
"judgment": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"template": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {
"suggested_context": {
"recipe": {
"fields": [
"<string>"
],
"last_n": {},
"window": {},
"max_tokens": 2,
"related": {}
},
"cost_per_answer": 1,
"whole_state_cost_per_answer": 1,
"sampled_documents": 2,
"excluded": [
{
"path": "<string>",
"reason": "id"
}
]
}
}
}
}Authorizations
An organization API key. Keys carry a role (read_write or
read_only) and may be restricted to a namespace prefix such as
acme/*, or to one namespace such as acme/prod/tenant_1. A prefix
matches on a / boundary: acme/prod/tenant_1* covers
acme/prod/tenant_1 and everything under acme/prod/tenant_1/,
never acme/prod/tenant_12.
Headers
Returns the original response verbatim while the node still caches it. Correctness never depends on it.
Minimum string length:
1Path Parameters
A namespace name, or a template prefix ending in /* (§7.7), with any
/ sent as %2F: acme%2Fprod%2Ftenant_123 or acme%2Fprod%2F*.
A namespace name, or a template prefix: a namespace path ending in
/*, such as acme/prod/*, which every namespace under acme/prod/
inherits judgments from (§7.7). Up to 256 bytes.
Required string length:
1 - 256Pattern:
^[A-Za-z0-9._:/-]+(/\*)?$A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..
Required string length:
1 - 128Pattern:
^[A-Za-z0-9_-]+$Body
application/json
Every key is optional; the others keep their values. filters never changes.
Minimum array length:
1entered when a document starts matching; exited when it stops matching or is deleted.
Available options:
entered, exited The attributes and answers each event carries. The fields the
filter reads are always included, and state never is. At most 24
fields in all, counting those the filter reads. An on_read
judgment is refused.
Show child attributes
Show child attributes
Null sends the events to the feed only.
Pattern:
^we_[0-9a-z]{26}$What bulk changes send: a backfill, the first sync, or a resync
after a threshold edit, an activation or new composite weights.
summary updates membership silently and sends one
subscription.synced. deliver sends every transition, with its
cause.
Available options:
summary, deliver Response
The subscription as changed.
Pattern:
^sub_[0-9a-z]{26}$A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..
Required string length:
1 - 128Pattern:
^[A-Za-z0-9_-]+$[field, op, value], ["And" | "Or", [filters]] or ["Not", filter].
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
entered when a document starts matching; exited when it stops matching or is deleted.
Available options:
entered, exited The attributes and answers each event carries. The fields the
filter reads are always included, and state never is. At most 24
fields in all, counting those the filter reads. An on_read
judgment is refused.
Show child attributes
Show child attributes
Pattern:
^we_[0-9a-z]{26}$What bulk changes send: a backfill, the first sync, or a resync
after a threshold edit, an activation or new composite weights.
summary updates membership silently and sends one
subscription.synced. deliver sends every transition, with its
cause.
Available options:
summary, deliver In this namespace. Null on a template's prefix path, where each namespace syncs on its first change after the subscription exists.
Available options:
syncing, live When the subscription went live in this namespace.
How long the oldest change the subscription has not evaluated yet has waited, in milliseconds; 0 when it is up to date. A quiet subscription records its progress about once a minute, so a change counts only once it has waited longer than that. Null while syncing and on a template's prefix path.
Required range:
x >= 0Show child attributes
Show child attributes
RFC 3339, UTC.
Present when the subscription is inherited, the template prefix it comes from, such as acme/prod/*.
Required string length:
3 - 256Pattern:
^[A-Za-z0-9._:/-]+/\*$