intentic
Download the app
Download the app
Agent setup

Privacy shield

What personal data is kept from model providers, and the record of what was masked

On this page(20 sections)

The shield replaces names, numbers and other personal data with tokens before a request reaches a provider you have not trusted, and puts the real values back on the way out. These routes read its state and replace its policy, which only the owner may do; read the log of what it masked; look a word up in the name dictionary; and list, teach and forget the datasets of known values it masks wherever they appear.

20 calls. Pick one to open it, or use the list on the right.

GET/privacy/shieldThe privacy shield and what it covers

Whether personal data is kept from untrusted model providers, which providers are trusted, which local readers are installed, and how many values it has learned.

What you send

Nothing. Call it as it is.

What comes back

FieldType
policyobject
modeWhether the shield is off, only…"off" | "watch" | "on"
trustedProviders that may read personal data…string[]
classesWhich kinds of personal data are…"person-name" | "national-id" | "tax-id" | "identity-document" … (9)[]
imagesWhat an image bound for an…"mask" | "allow"
namesHow names are found"dictionary" | "model"
allowValues never masked: your own company,…string[]
conversationsProviders that may read one conversation's…object[]
conversationIdstring
providerProvider id, as the trusted list…string
dictionaryThe name dictionary as the owner…object
offBuilt-in name lists switched off, by…string[]
listsThe owner's own name lists, read…object[]
idstring
titlestring
kind"first-name" | "surname" | "ambiguous" | "title" … (5)
matching"inflected" | "as-written"
wordsOne word each, in any case:…string[]
onboolean
rulesThe owner's own rules: words, phrases…object[]
idstring
titlestring
onboolean
classThe kind what it matches is…"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
match"terms" | "pattern"
termsstring[]
patternstring
matchCaseboolean
knownValues taught from your datasets, matched…integer
tokensValues the shield has given a…integer
readersobject
ocrThe local text reader (PaddleOCR) that…boolean
modelA local named-entity model for names…boolean
providersobject[]
idProvider id, as the trusted list…string
labelstring
shieldableThe shield can read what its…boolean
localIt runs on this machine, so…boolean
Try itanswered in this tab
curl
curl "$SANDBOX/privacy/shield" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.status();
POST/privacy/shieldChange the privacy shield

Replaces the policy whole. Turning the shield on puts every turn that starts from then on, whose runtime can be shielded, behind the gateway, and refuses the turns that cannot be shielded on an untrusted provider; a turn already running keeps the route it started with. A change to what is masked or trusted holds from the next model request.

What you send

FieldTypeWhere
modeWhether the shield is off, only…"off" | "watch" | "on"body
trustedProviders that may read personal data…string[]body
classesWhich kinds of personal data are…"person-name" | "national-id" | "tax-id" | "identity-document" … (9)[]body
imagesWhat an image bound for an…"mask" | "allow"body
namesHow names are found"dictionary" | "model"body
allowValues never masked: your own company,…string[]body
conversationsProviders that may read one conversation's…object[]body
conversationIdrequiredstringbody
providerrequiredProvider id, as the trusted list…stringbody
dictionaryThe name dictionary as the owner…objectbody
offBuilt-in name lists switched off, by…string[]body
listsThe owner's own name lists, read…object[]body
idrequiredstringbody
titlerequiredstringbody
kindrequired"first-name" | "surname" | "ambiguous" | "title" … (5)body
matching"inflected" | "as-written"body
wordsOne word each, in any case:…string[]body
onbooleanbody
rulesThe owner's own rules: words, phrases…object[]body
idrequiredstringbody
titlerequiredstringbody
onbooleanbody
classrequiredThe kind what it matches is…"person-name" | "national-id" | "tax-id" | "identity-document" … (9)body
matchrequired"terms" | "pattern"body
termsstring[]body
patternstringbody
matchCasebooleanbody

What comes back

FieldType
okAlways truetrue
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/shield" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"mode":"off","trusted":["…","…"],"classes":["person-name","national-id"],"images":"mask","names":"dictionary","allow":["…","…"],"conversations":[{"conversationId":"nightly-changelog","provider":"claude"},{"conversationId":"release-notes","provider":"claude"}],"dictionary":{"off":["…","…"],"lists":[{"id":"a1b2c3d4","title":"Update the changelog","kind":"first-name","matching":"inflected","words":["…","…"],"on":true},{"id":"e5f6a7b8","title":"Draft the release notes","kind":"surname","matching":"as-written","words":["…","…"],"on":true}]},"rules":[{"id":"a1b2c3d4","title":"Update the changelog","on":true,"class":"person-name","match":"terms","terms":["…","…"],"pattern":"","matchCase":false},{"id":"e5f6a7b8","title":"Draft the release notes","on":true,"class":"national-id","match":"pattern","terms":["…","…"],"pattern":"","matchCase":false}]}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.setPolicy({
  "mode": "off",
  "trusted": [
    "…",
    "…"
  ],
  "classes": [
    "person-name",
    "national-id"
  ],
  "images": "mask",
  "names": "dictionary",
  "allow": [
    "…",
    "…"
  ],
  "conversations": [
    {
      "conversationId": "nightly-changelog",
      "provider": "claude"
    },
    {
      "conversationId": "release-notes",
      "provider": "claude"
    }
  ],
  "dictionary": {
    "off": [
      "…",
      "…"
    ],
    "lists": [
      {
        "id": "a1b2c3d4",
        "title": "Update the changelog",
        "kind": "first-name",
        "matching": "inflected",
        "words": [
          "…",
          "…"
        ],
        "on": true
      },
      {
        "id": "e5f6a7b8",
        "title": "Draft the release notes",
        "kind": "surname",
        "matching": "as-written",
        "words": [
          "…",
          "…"
        ],
        "on": true
      }
    ]
  },
  "rules": [
    {
      "id": "a1b2c3d4",
      "title": "Update the changelog",
      "on": true,
      "class": "person-name",
      "match": "terms",
      "terms": [
        "…",
        "…"
      ],
      "pattern": "",
      "matchCase": false
    },
    {
      "id": "e5f6a7b8",
      "title": "Draft the release notes",
      "on": true,
      "class": "national-id",
      "match": "pattern",
      "terms": [
        "…",
        "…"
      ],
      "pattern": "",
      "matchCase": false
    }
  ]
});
GET/privacy/logWhat the privacy shield did lately

Each model request the gateway handled: which provider, whether it was trusted, how many of each kind of personal data it found, and the tokens it gave with the masked text around them. Never the values.

What you send

Nothing. Call it as it is.

What comes back

FieldType
atWhen, as an ISO timestampstring
conversationIdstring
providerstring
trustedboolean
action"masked" | "watched" | "passed" | "refused"
countsHow many of each kind were…object
imagesImages the shield changed: personal data…integer
documentsDocuments read here: a PDF sent…integer
protocolWhich wire format the request spokestring
detailWhy it was refused, when it…string
replacementsThe first values replaced in what…object[]
tokenThe token the value became, as…string
class"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
excerptThe masked text around the token…string
imageFound in an image's text, so…boolean
imageIdThe image it was painted over,…string
Try itanswered in this tab
curl
curl "$SANDBOX/privacy/log" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.log();
GET/privacy/shieldedWords a conversation's model never read

The values in the conversation's replies that its model wrote as tokens, each with the token it wrote, so the chat can tell them from the model's own words. Empty while the shield does not mask the conversation's provider. Only someone who can read the conversation may ask.

What you send

FieldTypeWhere
conversationIdrequiredstringquery

What comes back

FieldType
textThe value as it stands in…string
tokenWhat the model read and wrote…string
class"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
Try itanswered in this tab
curl
curl "$SANDBOX/privacy/shielded?conversationId=nightly-changelog" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.shielded({
  "conversationId": "nightly-changelog"
});
POST/privacy/revealRead tokens back to their values

The value each token stands for, from the vault, so the owner can check what the shield masked and spot a value it should have left alone. Only the owner may ask; a token the vault never gave out is left out.

What you send

FieldTypeWhere
tokensrequiredstring[]body

What comes back

A plain value rather than an object. The example below is the whole of it.

Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/reveal" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"tokens":["ict_9wQ4rTz8kLmN3pXbV7hJ","ict_9wQ4rTz8kLmN3pXbV7hJ"]}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.reveal({
  "tokens": [
    "ict_9wQ4rTz8kLmN3pXbV7hJ",
    "ict_9wQ4rTz8kLmN3pXbV7hJ"
  ]
});
POST/privacy/imageAn image before and after masking

The picture as it was and as the shield painted it before it left, for a log entry's image replacement. The picture before holds the personal data, so only the owner may ask. Only the most recent images are kept; an older one answers not found.

What you send

FieldTypeWhere
idrequiredstringbody

What comes back

FieldType
atWhen it was first painted, as…string
beforeobject
mediaTypestring
dataBase64string
afterobject
mediaTypestring
dataBase64string
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/image" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"id":"a1b2c3d4"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.image({
  "id": "a1b2c3d4"
});
GET/privacy/dictionaryThe name lists the shield finds names by

Every list the dictionary holds (first names, surnames, words that are names only beside other evidence, titles), the owner's own lists among them, whether each is switched on, how many words each has and where they come from. With a query, what the dictionary as the owner set it makes of it as a name, and for one word the listed words starting with it.

What you send

FieldTypeWhere
queryA word, the start of one,…stringquery

What comes back

FieldType
listsobject[]
idStable id of the liststring
kindWhat a word on it says…"first-name" | "surname" | "ambiguous" | "title" … (5)
languagesThe languages its words come from;…"pl" | "en" | "multi"[]
countHow many words it holdsinteger
matchinginflected: matched in every grammatical form…"inflected" | "as-written"
sourceWhere the words come from: the…string
urlThe source's page, where it has…string
licensestring
onRead by the shield; the owner…boolean
ownOne of the owner's own lists…boolean
titleAn own list's titlestring
totalsDistinct words across the first-name lists,…object
firstNamesinteger
surnamesinteger
matchesobject[]
wordstring
listsIds of the lists holding itstring[]
lookupobject
textThe query as a name is…string
foundWhether the dictionary alone masks it…boolean
wordsobject[]
wordstring
firstNameA listed first name, in this…boolean
surnameA listed surname, in this form…boolean
surnameFormShaped like a Polish surname (-ski,…boolean
ambiguousAlso an ordinary word in some…boolean
neverNever taken as part of a…boolean
Try itanswered in this tab
curl
curl "$SANDBOX/privacy/dictionary" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.dictionary();
POST/privacy/previewTry the shield on a text

What the shield would mask in the text with the policy as saved (every detector, the name lists, the owner's own rules, the values the vault knows) and what found each. Nothing is given a token or kept, whatever the switch says.

What you send

FieldTypeWhere
textrequiredstringbody

What comes back

FieldType
spansobject[]
startinteger
endExclusiveinteger
class"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
bydetector: the built-in detectors and name…"detector" | "rule" | "learned" | "model"
ruleThe id of the owner's rule…string
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/preview" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"text":"export const start = () => listen(PORT);\n"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.preview({
  "text": "export const start = () => listen(PORT);\n"
});
GET/privacy/knownThe datasets taught to the shield

Each source values were taught from, and how many. The values themselves are never sent back.

What you send

Nothing. Call it as it is.

What comes back

FieldType
sourceWhere the values came from, as…string
countinteger
atWhen they were last taughtstring
Try itanswered in this tab
curl
curl "$SANDBOX/privacy/known" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.sources();
POST/privacy/knownTeach the shield a dataset's values

Each value is masked wherever it appears from now on, in every form it is written, whether or not the detectors would have found it. Teaching only ever masks more, so the agent may do it.

What you send

FieldTypeWhere
sourcerequiredWhere the values came from: a…stringbody
valuesrequiredobject[]body
valuerequiredstringbody
classrequired"person-name" | "national-id" | "tax-id" | "identity-document" … (9)body

What comes back

FieldType
addedinteger
knowninteger
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/known" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"source":"…","values":[{"value":"…","class":"person-name"},{"value":"…","class":"national-id"}]}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.learn({
  "source": "…",
  "values": [
    {
      "value": "…",
      "class": "person-name"
    },
    {
      "value": "…",
      "class": "national-id"
    }
  ]
});
GET/privacy/leaksPersonal data that reached a provider unmasked, and the proposals to catch more like it

Every reported or suspected leak with its outline, the field label before it, what the name lists say of its words and what finds it now without its exact copy in the vault; and the hardening proposals waiting for the owner. Values and the text around them only for a person who runs the shield, or an agent whose conversation runs on a trusted or local provider.

What you send

Nothing. Call it as it is.

What comes back

FieldType
leaksobject[]
idstring
atstring
class"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
origin"reported" | "scan"
state"suspected" | "confirmed" | "dismissed"
whystring
conversationIdstring
outlineThe value with each capital as…string
lengthinteger
labelUp to four words just before…string
wordsEach word of the value, in…object[]
outlineThe word with each capital as…string
firstNameboolean
surnameboolean
surnameFormShaped like a Polish surname (-ski,…boolean
ambiguousAlso an ordinary word in some…boolean
neverboolean
caughtWhat finds it now with the…"rule" | "detector" | "model" | "no"
valueOnly for someone who may read…string
contextOnly for someone who may read…string
proposalsobject[]
idstring
atstring
conversationIdstring
titlestring
whystring
hardeningobject
rulesobject[]
titlestring
class"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
match"terms" | "pattern"
termsstring[]
patternstring
matchCaseboolean
listsobject[]
titlestring
kind"first-name" | "surname" | "ambiguous" | "title" … (5)
matching"inflected" | "as-written"
wordsstring[]
fromLeaksobject[]
measuredobject
leaksobject
totalConfirmed leaks measured againstinteger
beforeCaught by the policy as saved,…integer
afterCaught with the additionsinteger
missedIds of the confirmed leaks still…string[]
controlobject
conversationsinteger
charsinteger
addedValues the additions would mask there…integer
samplesobject[]
problemsRules that cannot be saved as…string[]
wordsobject
revealedWhether this reader is shown values:…boolean
sessionThe hardening session last started from…object
conversationIdstring
atstring
Try itanswered in this tab
curl
curl "$SANDBOX/privacy/leaks" \
  -H "x-intentic-control: $INTENTIC_TOKEN"
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.leaks();
POST/privacy/leaksReport a value the shield should have masked

Kept as a confirmed leak, and its exact value taught to the vault: masked wherever it appears from now on. Reporting only ever masks more, so the agent may do it.

What you send

FieldTypeWhere
valuerequiredstringbody
classrequired"person-name" | "national-id" | "tax-id" | "identity-document" … (9)body
contextThe text it stood in; the…stringbody
conversationIdstringbody

What comes back

FieldType
idstring
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/leaks" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"value":"…","class":"person-name","context":"…","conversationId":"nightly-changelog"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.report({
  "value": "…",
  "class": "person-name",
  "context": "…",
  "conversationId": "nightly-changelog"
});
POST/privacy/leaks/judgeConfirm or dismiss a leak

Confirming teaches its exact value to the vault, so it is masked from now on. Dismissing says it is no personal data: a value taught for it is forgotten, and a scan does not suggest it again.

What you send

FieldTypeWhere
idrequiredstringbody
staterequired"confirmed" | "dismissed"body

What comes back

FieldType
okAlways truetrue
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/leaks/judge" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"id":"a1b2c3d4","state":"confirmed"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.judge({
  "id": "a1b2c3d4",
  "state": "confirmed"
});
POST/privacy/leaks/scanLook for leaks in recent conversations, on this machine

Reads the most recent conversations here and suspects every value nothing masks that the local name model reads as a name, or that stands under a field labelled as personal data (PESEL, passport, e-mail…). Nothing leaves this machine and nothing is taught: the owner confirms or dismisses each.

What you send

FieldTypeWhere
conversationsintegerbody

What comes back

FieldType
conversationsinteger
charsinteger
suspectedinteger
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/leaks/scan" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"conversations":1}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.scan({
  "conversations": 1
});
POST/privacy/leaks/tryMeasure rules and name-list words before proposing them

Adds them to the policy as saved and measures, on this machine: how many confirmed leaks they catch that nothing catches now, and what they would mask in recent conversations that nothing masks today, as outlines (values only for a reader who may read them). Nothing is saved.

What you send

FieldTypeWhere
rulesobject[]body
titlerequiredstringbody
classrequired"person-name" | "national-id" | "tax-id" | "identity-document" … (9)body
matchrequired"terms" | "pattern"body
termsstring[]body
patternstringbody
matchCasebooleanbody
listsobject[]body
titlerequiredstringbody
kindrequired"first-name" | "surname" | "ambiguous" | "title" … (5)body
matching"inflected" | "as-written"body
wordsstring[]body
fromLeaksobject[]body
leakrequiredstringbody
wordrequiredintegerbody

What comes back

FieldType
leaksobject
totalConfirmed leaks measured againstinteger
beforeCaught by the policy as saved,…integer
afterCaught with the additionsinteger
missedIds of the confirmed leaks still…string[]
controlobject
conversationsinteger
charsinteger
addedValues the additions would mask there…integer
samplesobject[]
class"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
outlinestring
labelstring
valueOnly for someone who may read…string
problemsRules that cannot be saved as…string[]
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/leaks/try" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"rules":[{"title":"Update the changelog","class":"person-name","match":"terms","terms":["…","…"],"pattern":"","matchCase":false},{"title":"Draft the release notes","class":"national-id","match":"pattern","terms":["…","…"],"pattern":"","matchCase":false}],"lists":[{"title":"Update the changelog","kind":"first-name","matching":"inflected","words":["…","…"],"fromLeaks":[{"leak":"…","word":0},{"leak":"…","word":0}]},{"title":"Draft the release notes","kind":"surname","matching":"as-written","words":["…","…"],"fromLeaks":[{"leak":"…","word":0},{"leak":"…","word":0}]}]}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.tryHardening({
  "rules": [
    {
      "title": "Update the changelog",
      "class": "person-name",
      "match": "terms",
      "terms": [
        "…",
        "…"
      ],
      "pattern": "",
      "matchCase": false
    },
    {
      "title": "Draft the release notes",
      "class": "national-id",
      "match": "pattern",
      "terms": [
        "…",
        "…"
      ],
      "pattern": "",
      "matchCase": false
    }
  ],
  "lists": [
    {
      "title": "Update the changelog",
      "kind": "first-name",
      "matching": "inflected",
      "words": [
        "…",
        "…"
      ],
      "fromLeaks": [
        {
          "leak": "…",
          "word": 0
        },
        {
          "leak": "…",
          "word": 0
        }
      ]
    },
    {
      "title": "Draft the release notes",
      "kind": "surname",
      "matching": "as-written",
      "words": [
        "…",
        "…"
      ],
      "fromLeaks": [
        {
          "leak": "…",
          "word": 0
        },
        {
          "leak": "…",
          "word": 0
        }
      ]
    }
  ]
});
POST/privacy/proposalsPropose rules and name-list words to the owner

Measured as tryHardening measures them, and kept for the owner, who applies or dismisses it on the privacy page. A rule whose pattern cannot be saved is refused here.

What you send

FieldTypeWhere
titlerequiredstringbody
whystringbody
hardeningrequiredobjectbody
rulesobject[]body
titlerequiredstringbody
classrequired"person-name" | "national-id" | "tax-id" | "identity-document" … (9)body
matchrequired"terms" | "pattern"body
termsstring[]body
patternstringbody
matchCasebooleanbody
listsobject[]body
titlerequiredstringbody
kindrequired"first-name" | "surname" | "ambiguous" | "title" … (5)body
matching"inflected" | "as-written"body
wordsstring[]body
fromLeaksobject[]body
leakrequiredstringbody
wordrequiredintegerbody

What comes back

FieldType
idstring
measuredobject
leaksobject
totalConfirmed leaks measured againstinteger
beforeCaught by the policy as saved,…integer
afterCaught with the additionsinteger
missedIds of the confirmed leaks still…string[]
controlobject
conversationsinteger
charsinteger
addedValues the additions would mask there…integer
samplesobject[]
class"person-name" | "national-id" | "tax-id" | "identity-document" … (9)
outlinestring
labelstring
valueOnly for someone who may read…string
problemsRules that cannot be saved as…string[]
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/proposals" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"title":"Update the changelog","why":"","hardening":{"rules":[{"title":"Update the changelog","class":"person-name","match":"terms","terms":["…","…"],"pattern":"","matchCase":false},{"title":"Draft the release notes","class":"national-id","match":"pattern","terms":["…","…"],"pattern":"","matchCase":false}],"lists":[{"title":"Update the changelog","kind":"first-name","matching":"inflected","words":["…","…"],"fromLeaks":[{},{}]},{"title":"Draft the release notes","kind":"surname","matching":"as-written","words":["…","…"],"fromLeaks":[{},{}]}]}}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.propose({
  "title": "Update the changelog",
  "why": "",
  "hardening": {
    "rules": [
      {
        "title": "Update the changelog",
        "class": "person-name",
        "match": "terms",
        "terms": [
          "…",
          "…"
        ],
        "pattern": "",
        "matchCase": false
      },
      {
        "title": "Draft the release notes",
        "class": "national-id",
        "match": "pattern",
        "terms": [
          "…",
          "…"
        ],
        "pattern": "",
        "matchCase": false
      }
    ],
    "lists": [
      {
        "title": "Update the changelog",
        "kind": "first-name",
        "matching": "inflected",
        "words": [
          "…",
          "…"
        ],
        "fromLeaks": [
          {},
          {}
        ]
      },
      {
        "title": "Draft the release notes",
        "kind": "surname",
        "matching": "as-written",
        "words": [
          "…",
          "…"
        ],
        "fromLeaks": [
          {},
          {}
        ]
      }
    ]
  }
});
POST/privacy/proposals/applyApply a hardening proposal to the policy

Its rules are added and switched on, and its words go onto the owner's own list of the same title and kind, or a new one; a word named by its leak is read from that leak here.

What you send

FieldTypeWhere
idrequiredstringbody

What comes back

FieldType
okAlways truetrue
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/proposals/apply" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"id":"a1b2c3d4"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.applyProposal({
  "id": "a1b2c3d4"
});
POST/privacy/proposals/dismissDismiss a hardening proposal

What you send

FieldTypeWhere
idrequiredstringbody

What comes back

FieldType
okAlways truetrue
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/proposals/dismiss" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"id":"a1b2c3d4"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.dismissProposal({
  "id": "a1b2c3d4"
});
POST/privacy/leaks/sessionNote the hardening session started from the page

So the page offers to open it rather than starting a second one while it is still on the board.

What you send

FieldTypeWhere
conversationIdrequiredstringbody

What comes back

FieldType
okAlways truetrue
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/leaks/session" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"conversationId":"nightly-changelog"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.hardeningSession({
  "conversationId": "nightly-changelog"
});
POST/privacy/known/forgetForget a taught dataset

Stops matching the values taught from one source. Tokens already given to them still resolve, so earlier conversations keep reading right.

What you send

FieldTypeWhere
sourcerequiredstringbody

What comes back

FieldType
forgotteninteger
Try itanswered in this tab
curl
curl -X POST "$SANDBOX/privacy/known/forget" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"source":"…"}'
TypeScript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.privacy.forget({
  "source": "…"
});

Type to search every page, in the docs and the API reference.