# One farewell per conversation: the check reserved the effect, the declaration settles it
key = f"farewell:{conversation.conversation_id}"
decision = conversation.check("farewell", purpose="service", effect_key=key)
if decision.decision == "allow" and decision.effect and decision.effect.state == "none":
try:
send(farewell)
conversation.declare.effect(key, "done")
except TimeoutError:
conversation.declare.effect(key, "unknown_outcome") # never sent again on its own// One farewell per conversation: the check reserved the effect, the declaration settles it
const key = `farewell:${convo.id}`;
const decision = await convo.check("farewell", { purpose: "service", effectKey: key });
if (decision.decision === "allow" && decision.effect?.state === "none") {
try {
await send(farewell);
convo.declare.effect(key, "done");
} catch {
convo.declare.effect(key, "unknown_outcome"); // never sent again on its own
}
}curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/coordination/declare \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"agent": "<string>",
"detail": {
"lease_s": 43200,
"intents": [
"<string>"
],
"level": "<string>"
},
"kind": "case.opened",
"object": {
"id": "<string>",
"namespace": "<string>",
"type": "<string>"
},
"subject": {
"value": "<string>",
"scope": "<string>"
}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
agent: '<string>',
detail: {lease_s: 43200, intents: ['<string>'], level: '<string>'},
kind: 'case.opened',
object: {id: '<string>', namespace: '<string>', type: '<string>'},
subject: {value: '<string>', scope: '<string>'}
})
};
fetch('https://{space}.{region}.api.niadra.com/v1/coordination/declare', 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://{space}.{region}.api.niadra.com/v1/coordination/declare",
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([
'agent' => '<string>',
'detail' => [
'lease_s' => 43200,
'intents' => [
'<string>'
],
'level' => '<string>'
],
'kind' => 'case.opened',
'object' => [
'id' => '<string>',
'namespace' => '<string>',
'type' => '<string>'
],
'subject' => [
'value' => '<string>',
'scope' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://{space}.{region}.api.niadra.com/v1/coordination/declare"
payload := strings.NewReader("{\n \"agent\": \"<string>\",\n \"detail\": {\n \"lease_s\": 43200,\n \"intents\": [\n \"<string>\"\n ],\n \"level\": \"<string>\"\n },\n \"kind\": \"case.opened\",\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"subject\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://{space}.{region}.api.niadra.com/v1/coordination/declare")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent\": \"<string>\",\n \"detail\": {\n \"lease_s\": 43200,\n \"intents\": [\n \"<string>\"\n ],\n \"level\": \"<string>\"\n },\n \"kind\": \"case.opened\",\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"subject\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/coordination/declare")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": \"<string>\",\n \"detail\": {\n \"lease_s\": 43200,\n \"intents\": [\n \"<string>\"\n ],\n \"level\": \"<string>\"\n },\n \"kind\": \"case.opened\",\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"subject\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"accepted": true,
"decision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Declare what happened
After acting: a case opened or closed, a contact made, how an effect ended, a commitment, a handoff, a suppression added or lifted. With an Idempotency-Key.
# One farewell per conversation: the check reserved the effect, the declaration settles it
key = f"farewell:{conversation.conversation_id}"
decision = conversation.check("farewell", purpose="service", effect_key=key)
if decision.decision == "allow" and decision.effect and decision.effect.state == "none":
try:
send(farewell)
conversation.declare.effect(key, "done")
except TimeoutError:
conversation.declare.effect(key, "unknown_outcome") # never sent again on its own// One farewell per conversation: the check reserved the effect, the declaration settles it
const key = `farewell:${convo.id}`;
const decision = await convo.check("farewell", { purpose: "service", effectKey: key });
if (decision.decision === "allow" && decision.effect?.state === "none") {
try {
await send(farewell);
convo.declare.effect(key, "done");
} catch {
convo.declare.effect(key, "unknown_outcome"); // never sent again on its own
}
}curl --request POST \
--url https://{space}.{region}.api.niadra.com/v1/coordination/declare \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"agent": "<string>",
"detail": {
"lease_s": 43200,
"intents": [
"<string>"
],
"level": "<string>"
},
"kind": "case.opened",
"object": {
"id": "<string>",
"namespace": "<string>",
"type": "<string>"
},
"subject": {
"value": "<string>",
"scope": "<string>"
}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
agent: '<string>',
detail: {lease_s: 43200, intents: ['<string>'], level: '<string>'},
kind: 'case.opened',
object: {id: '<string>', namespace: '<string>', type: '<string>'},
subject: {value: '<string>', scope: '<string>'}
})
};
fetch('https://{space}.{region}.api.niadra.com/v1/coordination/declare', 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://{space}.{region}.api.niadra.com/v1/coordination/declare",
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([
'agent' => '<string>',
'detail' => [
'lease_s' => 43200,
'intents' => [
'<string>'
],
'level' => '<string>'
],
'kind' => 'case.opened',
'object' => [
'id' => '<string>',
'namespace' => '<string>',
'type' => '<string>'
],
'subject' => [
'value' => '<string>',
'scope' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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://{space}.{region}.api.niadra.com/v1/coordination/declare"
payload := strings.NewReader("{\n \"agent\": \"<string>\",\n \"detail\": {\n \"lease_s\": 43200,\n \"intents\": [\n \"<string>\"\n ],\n \"level\": \"<string>\"\n },\n \"kind\": \"case.opened\",\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"subject\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://{space}.{region}.api.niadra.com/v1/coordination/declare")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent\": \"<string>\",\n \"detail\": {\n \"lease_s\": 43200,\n \"intents\": [\n \"<string>\"\n ],\n \"level\": \"<string>\"\n },\n \"kind\": \"case.opened\",\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"subject\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{space}.{region}.api.niadra.com/v1/coordination/declare")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent\": \"<string>\",\n \"detail\": {\n \"lease_s\": 43200,\n \"intents\": [\n \"<string>\"\n ],\n \"level\": \"<string>\"\n },\n \"kind\": \"case.opened\",\n \"object\": {\n \"id\": \"<string>\",\n \"namespace\": \"<string>\",\n \"type\": \"<string>\"\n },\n \"subject\": {\n \"value\": \"<string>\",\n \"scope\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"accepted": true,
"decision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "<string>",
"status": 123,
"title": "<string>",
"detail": "<string>",
"request_id": "<string>",
"type": "about:blank"
}Authorizations
nia_sk_...
Headers
Required. Kept 24 hours with the hash of the body: a retry with the same key returns the first answer, and the same key with a different body returns 409 conflict.
1 - 256Body
- CaseOpened
- CaseClosed
- LeaseDeclared
- TaskLockDeclared
- ContactMade
- EffectDeclared
- CommitmentMade
- CommitmentWithdrawn
- CommitmentDecided
- HandoffDeclared
- SuppressionAdded
- SuppressionLifted
What happened, after the fact: one kind of declaration, with the fields of its kind in detail (the
coordination spec, 5).
1 - 256An owner lease or a case, held by the declaring agent. level defaults to the space's least
restrictive level.
Show child attributes
Show child attributes
"case.opened"A business object in a system of record, e.g. invoice / erp / 0823.
Show child attributes
Show child attributes
An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.
Show child attributes
Show child attributes

