Return the stored redaction for a dataset’s sample: which columns hold personal data, and how
each is masked. Apply it with GET /datasets/{dataset_id}/sample/redacted.
A redaction gets here one of two ways: you upload one with PUT /datasets/{dataset_id}/redaction,
or Narrative’s privacy model writes one. POST /v2/datasets/{dataset_id}/request-sample asks the
model for one in a single call, and the GenerateSampleRedaction workflow task asks for the same
thing as a step in a workflow of your own. model_version tells an uploaded redaction from a
generated one.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
dataset_id
integer
required
Unique identifier for a dataset.
Response
OK
The stored redaction for one dataset's sample.
dataset_id
integer
required
The dataset this redaction belongs to.
columns
object[]
required
One entry per column that holds personal data.
Show child attributes
written_by
UserResourceOwner · object
required
Who was authenticated when the redaction was written, taken from the access token rather than
from anything the caller sent. One variant per kind of grant a token can carry, each tagged with
type:
user_resource_owner: a token issued directly to a user of a company.
app_installation: a token issued to an app a company installed. user_id is null when the
app issued itself the token rather than acting for a user.
app_client_credentials: a token issued to an app on its own credentials, which carries no
user and no company.
The privacy model that produced the redaction, named by the model repository the worker
loaded. A deployment can point the worker at a different repository, so read the value rather
than expecting a fixed one.
Null on a redaction you uploaded yourself: PUT /datasets/{dataset_id}/redaction refuses this
field from any caller but Narrative, and an upload that leaves it out clears a stored value.
Maximum string length: 128
created_at
string<date-time>
required
When the dataset's first redaction was written. Survives later uploads.
updated_at
string<date-time>
required
When the redaction was last written or deleted.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Narrative I/O Knowledge Base","colors":{"primary":"#1438F5","light":"#F4F7FB","dark":"#010A28"},"logo":{"light":"https://mintcdn.com/narrative-07c7a1f7/ia6SQX79O4nc7uYf/logo/banner.png?fit=max\u0026auto=format\u0026n=ia6SQX79O4nc7uYf\u0026q=85\u0026s=99860b25011c79366624a87d1f648861","dark":"https://mintcdn.com/narrative-07c7a1f7/ia6SQX79O4nc7uYf/logo/banner-dark.png?fit=max\u0026auto=format\u0026n=ia6SQX79O4nc7uYf\u0026q=85\u0026s=604f9688855cf1123b9eddfc8a5bf0e5"},"favicon":"https://mintcdn.com/narrative-07c7a1f7/DaYE2y2_p0IkASZU/favicon.svg?fit=max\u0026auto=format\u0026n=DaYE2y2_p0IkASZU\u0026q=85\u0026s=9961047bdb2aaf9298577e1c3e624c24","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Open Narrative","href":"https://app.narrative.io"}},"footer":{"socials":{"github":"https://github.com/narrative-io","linkedin":"https://linkedin.com/company/narrative-io"}},"seo":{"indexing":"navigable"},"integrations":{"fathom":{"siteId":"WELVPSSZ"},"ga4":{"measurementId":"G-27FP7EFNFW"},"cookies":{}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Release Notes","icon":"clock-rotate-left","href":"/release-notes"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"narrative-07c7a1f7","hasAudioNarration":false,"actualSubdomain":"narrative-07c7a1f7","customDomains":["docs.narrative.io"],"gitSource":{"type":"github","owner":"narrative-io","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afcbbde4d7cf394a4abc5dd","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API Documentation","count":229},{"language":"default","tag":"Connectors","count":112},{"language":"default","tag":"Reference","count":112},{"language":"default","tag":"All connectors","count":110},{"language":"default","tag":"Architecture Reference","count":77},{"language":"default","tag":"Agent Conversations","count":64},{"language":"default","tag":"Concepts","count":62},{"language":"default","tag":"Guides","count":58},{"language":"default","tag":"Errors","count":55},{"language":"default","tag":"API reference","count":43}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"[email protected]","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"autopilot-knowledge-base","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/dataset-samples/get-a-datasets-sample-redaction","slug":"/api-reference/dataset-samples/get-a-datasets-sample-redaction","pageMetadata":{"title":"Get a dataset's sample redaction","description":"Return the stored redaction for a dataset's sample: which columns hold personal data, and how\neach is masked. Apply it with `GET /datasets/{dataset_id}/sample/redacted`.\n\nA redaction gets here one of two ways: you upload one with `PUT /datasets/{dataset_id}/redaction`,\nor Narrative's privacy model writes one. `POST /v2/datasets/{dataset_id}/request-sample` asks the\nmodel for one in a single call, and the `GenerateSampleRedaction` workflow task asks for the same\nthing as a step in a workflow of your own. `model_version` tells an uploaded redaction from a\ngenerated one.","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/redaction","href":"/api-reference/dataset-samples/get-a-datasets-sample-redaction","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Return the stored redaction for a dataset’s sample: which columns hold personal data, and how\\neach is masked. Apply it with \", _jsx(_components.code, {\n children: \"GET /datasets/{dataset_id}/sample/redacted\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A redaction gets here one of two ways: you upload one with \", _jsx(_components.code, {\n children: \"PUT /datasets/{dataset_id}/redaction\"\n }), \",\\nor Narrative’s privacy model writes one. \", _jsx(_components.code, {\n children: \"POST /v2/datasets/{dataset_id}/request-sample\"\n }), \" asks the\\nmodel for one in a single call, and the \", _jsx(_components.code, {\n children: \"GenerateSampleRedaction\"\n }), \" workflow task asks for the same\\nthing as a step in a workflow of your own. \", _jsx(_components.code, {\n children: \"model_version\"\n }), \" tells an uploaded redaction from a\\ngenerated one.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a dataset's sample redaction","description":"Return the stored redaction for a dataset's sample: which columns hold personal data, and how\neach is masked. Apply it with `GET /datasets/{dataset_id}/sample/redacted`.\n\nA redaction gets here one of two ways: you upload one with `PUT /datasets/{dataset_id}/redaction`,\nor Narrative's privacy model writes one. `POST /v2/datasets/{dataset_id}/request-sample` asks the\nmodel for one in a single call, and the `GenerateSampleRedaction` workflow task asks for the same\nthing as a step in a workflow of your own. `model_version` tells an uploaded redaction from a\ngenerated one.","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/redaction","href":"/api-reference/dataset-samples/get-a-datasets-sample-redaction","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/narrative-07c7a1f7/d5d45b2d00effc8b/secure-privacy.js"],"openApiReferenceData":{"operation":{"summary":"Get a dataset's sample redaction","description":"Return the stored redaction for a dataset's sample: which columns hold personal data, and how\neach is masked. Apply it with `GET /datasets/{dataset_id}/sample/redacted`.\n\nA redaction gets here one of two ways: you upload one with `PUT /datasets/{dataset_id}/redaction`,\nor Narrative's privacy model writes one. `POST /v2/datasets/{dataset_id}/request-sample` asks the\nmodel for one in a single call, and the `GenerateSampleRedaction` workflow task asks for the same\nthing as a step in a workflow of your own. `model_version` tells an uploaded redaction from a\ngenerated one.","tags":["Dataset Samples"],"parameters":["f877650b-4caa-4bd3-a9cf-4b8cd614d4de"],"security":["569c7eea-6609-4f11-9d87-306c36b9fb75"],"responses":{"200":"7816a08a-a435-4efa-8346-da87782d6ed1","401":"6c5d683b-525c-44e2-adee-84407b57437d","403":"ea36bb76-0325-407f-982c-4848b94861a4","404":"d0dfb96c-a5a7-46ae-b61b-a7363ca61243","500":"2c0ea981-ccf9-43e7-8408-ad5b152ebc43"},"method":"get","type":"path","servers":["299d6b6f-9132-4667-be5b-3d7b5c2803c1","e3a3cbac-9bb0-44b5-a4b2-7a20ffe245c6"],"path":"/datasets/{dataset_id}/redaction","baseUrlOptions":["https://api-dev.narrative.io","https://api.narrative.io"],"title":"Get a dataset's sample redaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f877650b-4caa-4bd3-a9cf-4b8cd614d4de":{"in":"path","name":"dataset_id","required":true,"description":"Unique identifier for a dataset.","schema":{"type":"integer","isRequired":true,"description":"Unique identifier for a dataset.","uniqueKey":"","typeLabel":"integer"}}},"responses":{"7816a08a-a435-4efa-8346-da87782d6ed1":{"description":"OK","content":{"application/json":{"schema":{"description":"The stored redaction for one dataset's sample.","type":"object","required":["dataset_id","columns","written_by","model_version","created_at","updated_at"],"properties":{"dataset_id":{"description":"The dataset this redaction belongs to.","type":"integer","isRequired":true,"uniqueKey":"dataset_id","typeLabel":"integer"},"columns":{"description":"One entry per column that holds personal data.","type":"array","items":{"description":"One column of the sample, the kind of personal data it holds, and how it is masked. The category\ndoes not constrain the strategy: a redaction you upload can pair any category with any strategy.","type":"object","required":["path","masking_strategy"],"properties":{"path":{"description":"Dot-separated path to the column in the sample, e.g. `email_address` or\n`payment.card_number`. A path that doesn't resolve in a row leaves that row untouched, so a\nredaction naming a since-renamed column quietly stops masking it.","type":"string","example":"email_address","isRequired":true,"uniqueKey":"columns.items.[INDEX].path","typeLabel":"string"},"masking_strategy":{"oneOf":[{"type":"object","title":"KeepEmailDomain","description":"How a column's value is masked. Seven variants, each a JSON object tagged with `type`:\n\n- `keep_email_domain`: keeps the domain, plus the local part's first and last two characters\n (or just its first character when the local part is two to four characters long, and nothing\n at all when it is one character). A value with no `@`, or one that starts with `@` and so has\n no local part, is masked completely, domain included: `@example.com` masks to `************`.\n- `keep_initials`: replaces each whitespace-separated token with its first letter and three mask\n characters, whatever the token's length, so `John Doe` becomes `J*** D***`.\n- `keep_network_prefix`: keeps an IPv4 address's `/24` and masks the rest. Anything else, IPv6\n included, is masked completely.\n- `keep_two_decimal_places`: rounds a coordinate to two decimal places. A value that isn't a\n coordinate is masked completely.\n- `keep_year`: returns the first four-digit run in the value and drops the rest, so `1985-03-12`\n becomes `1985`. A value with no four-digit run is masked completely.\n- `keep_last_digits`: keeps the last `count` digits, masks every other letter and digit, and\n leaves separators alone so the value's shape survives. When the value has no other letter or\n digit to mask it keeps one digit fewer, so `1234` with `count: 4` masks to `*234`.\n- `mask_everything`: keeps nothing.\n\nOn write, an unrecognised `type` is rejected with a 400 and nothing is stored. The 400 names the\ncolumn it refused, the value it didn't recognise, and all seven types it accepts. Accepting the\ntypo and masking some other way instead would be worse than refusing: someone who typed\n`keep_emial_domain` would believe the domain was being kept, see fully-masked values, and get\nnothing telling them the strategy they asked for wasn't the one in use.\n\nBoth read endpoints answer 500 for a stored `masking_strategy` this API can't read, rather than\nnaming a strategy nobody wrote or masking by one. That 500 carries a `log_id` and not the column\nthat failed, so quote it when you report the failure.","required":["type"],"example":{"type":"keep_email_domain"},"properties":{"type":{"type":"string","enum":["keep_email_domain"],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.0","typeLabel":"KeepEmailDomain · object"},{"type":"object","title":"KeepInitials","description":"How a column's value is masked. Seven variants, each a JSON object tagged with `type`:\n\n- `keep_email_domain`: keeps the domain, plus the local part's first and last two characters\n (or just its first character when the local part is two to four characters long, and nothing\n at all when it is one character). A value with no `@`, or one that starts with `@` and so has\n no local part, is masked completely, domain included: `@example.com` masks to `************`.\n- `keep_initials`: replaces each whitespace-separated token with its first letter and three mask\n characters, whatever the token's length, so `John Doe` becomes `J*** D***`.\n- `keep_network_prefix`: keeps an IPv4 address's `/24` and masks the rest. Anything else, IPv6\n included, is masked completely.\n- `keep_two_decimal_places`: rounds a coordinate to two decimal places. A value that isn't a\n coordinate is masked completely.\n- `keep_year`: returns the first four-digit run in the value and drops the rest, so `1985-03-12`\n becomes `1985`. A value with no four-digit run is masked completely.\n- `keep_last_digits`: keeps the last `count` digits, masks every other letter and digit, and\n leaves separators alone so the value's shape survives. When the value has no other letter or\n digit to mask it keeps one digit fewer, so `1234` with `count: 4` masks to `*234`.\n- `mask_everything`: keeps nothing.\n\nOn write, an unrecognised `type` is rejected with a 400 and nothing is stored. The 400 names the\ncolumn it refused, the value it didn't recognise, and all seven types it accepts. Accepting the\ntypo and masking some other way instead would be worse than refusing: someone who typed\n`keep_emial_domain` would believe the domain was being kept, see fully-masked values, and get\nnothing telling them the strategy they asked for wasn't the one in use.\n\nBoth read endpoints answer 500 for a stored `masking_strategy` this API can't read, rather than\nnaming a strategy nobody wrote or masking by one. That 500 carries a `log_id` and not the column\nthat failed, so quote it when you report the failure.","required":["type"],"example":{"type":"keep_email_domain"},"properties":{"type":{"type":"string","enum":["keep_initials"],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.1","typeLabel":"KeepInitials · object"},{"type":"object","title":"KeepNetworkPrefix","description":"How a column's value is masked. Seven variants, each a JSON object tagged with `type`:\n\n- `keep_email_domain`: keeps the domain, plus the local part's first and last two characters\n (or just its first character when the local part is two to four characters long, and nothing\n at all when it is one character). A value with no `@`, or one that starts with `@` and so has\n no local part, is masked completely, domain included: `@example.com` masks to `************`.\n- `keep_initials`: replaces each whitespace-separated token with its first letter and three mask\n characters, whatever the token's length, so `John Doe` becomes `J*** D***`.\n- `keep_network_prefix`: keeps an IPv4 address's `/24` and masks the rest. Anything else, IPv6\n included, is masked completely.\n- `keep_two_decimal_places`: rounds a coordinate to two decimal places. A value that isn't a\n coordinate is masked completely.\n- `keep_year`: returns the first four-digit run in the value and drops the rest, so `1985-03-12`\n becomes `1985`. A value with no four-digit run is masked completely.\n- `keep_last_digits`: keeps the last `count` digits, masks every other letter and digit, and\n leaves separators alone so the value's shape survives. When the value has no other letter or\n digit to mask it keeps one digit fewer, so `1234` with `count: 4` masks to `*234`.\n- `mask_everything`: keeps nothing.\n\nOn write, an unrecognised `type` is rejected with a 400 and nothing is stored. The 400 names the\ncolumn it refused, the value it didn't recognise, and all seven types it accepts. Accepting the\ntypo and masking some other way instead would be worse than refusing: someone who typed\n`keep_emial_domain` would believe the domain was being kept, see fully-masked values, and get\nnothing telling them the strategy they asked for wasn't the one in use.\n\nBoth read endpoints answer 500 for a stored `masking_strategy` this API can't read, rather than\nnaming a strategy nobody wrote or masking by one. That 500 carries a `log_id` and not the column\nthat failed, so quote it when you report the failure.","required":["type"],"example":{"type":"keep_email_domain"},"properties":{"type":{"type":"string","enum":["keep_network_prefix"],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.2","typeLabel":"KeepNetworkPrefix · object"},{"type":"object","title":"KeepTwoDecimalPlaces","description":"How a column's value is masked. Seven variants, each a JSON object tagged with `type`:\n\n- `keep_email_domain`: keeps the domain, plus the local part's first and last two characters\n (or just its first character when the local part is two to four characters long, and nothing\n at all when it is one character). A value with no `@`, or one that starts with `@` and so has\n no local part, is masked completely, domain included: `@example.com` masks to `************`.\n- `keep_initials`: replaces each whitespace-separated token with its first letter and three mask\n characters, whatever the token's length, so `John Doe` becomes `J*** D***`.\n- `keep_network_prefix`: keeps an IPv4 address's `/24` and masks the rest. Anything else, IPv6\n included, is masked completely.\n- `keep_two_decimal_places`: rounds a coordinate to two decimal places. A value that isn't a\n coordinate is masked completely.\n- `keep_year`: returns the first four-digit run in the value and drops the rest, so `1985-03-12`\n becomes `1985`. A value with no four-digit run is masked completely.\n- `keep_last_digits`: keeps the last `count` digits, masks every other letter and digit, and\n leaves separators alone so the value's shape survives. When the value has no other letter or\n digit to mask it keeps one digit fewer, so `1234` with `count: 4` masks to `*234`.\n- `mask_everything`: keeps nothing.\n\nOn write, an unrecognised `type` is rejected with a 400 and nothing is stored. The 400 names the\ncolumn it refused, the value it didn't recognise, and all seven types it accepts. Accepting the\ntypo and masking some other way instead would be worse than refusing: someone who typed\n`keep_emial_domain` would believe the domain was being kept, see fully-masked values, and get\nnothing telling them the strategy they asked for wasn't the one in use.\n\nBoth read endpoints answer 500 for a stored `masking_strategy` this API can't read, rather than\nnaming a strategy nobody wrote or masking by one. That 500 carries a `log_id` and not the column\nthat failed, so quote it when you report the failure.","required":["type"],"example":{"type":"keep_email_domain"},"properties":{"type":{"type":"string","enum":["keep_two_decimal_places"],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.3","typeLabel":"KeepTwoDecimalPlaces · object"},{"type":"object","title":"KeepYear","description":"How a column's value is masked. Seven variants, each a JSON object tagged with `type`:\n\n- `keep_email_domain`: keeps the domain, plus the local part's first and last two characters\n (or just its first character when the local part is two to four characters long, and nothing\n at all when it is one character). A value with no `@`, or one that starts with `@` and so has\n no local part, is masked completely, domain included: `@example.com` masks to `************`.\n- `keep_initials`: replaces each whitespace-separated token with its first letter and three mask\n characters, whatever the token's length, so `John Doe` becomes `J*** D***`.\n- `keep_network_prefix`: keeps an IPv4 address's `/24` and masks the rest. Anything else, IPv6\n included, is masked completely.\n- `keep_two_decimal_places`: rounds a coordinate to two decimal places. A value that isn't a\n coordinate is masked completely.\n- `keep_year`: returns the first four-digit run in the value and drops the rest, so `1985-03-12`\n becomes `1985`. A value with no four-digit run is masked completely.\n- `keep_last_digits`: keeps the last `count` digits, masks every other letter and digit, and\n leaves separators alone so the value's shape survives. When the value has no other letter or\n digit to mask it keeps one digit fewer, so `1234` with `count: 4` masks to `*234`.\n- `mask_everything`: keeps nothing.\n\nOn write, an unrecognised `type` is rejected with a 400 and nothing is stored. The 400 names the\ncolumn it refused, the value it didn't recognise, and all seven types it accepts. Accepting the\ntypo and masking some other way instead would be worse than refusing: someone who typed\n`keep_emial_domain` would believe the domain was being kept, see fully-masked values, and get\nnothing telling them the strategy they asked for wasn't the one in use.\n\nBoth read endpoints answer 500 for a stored `masking_strategy` this API can't read, rather than\nnaming a strategy nobody wrote or masking by one. That 500 carries a `log_id` and not the column\nthat failed, so quote it when you report the failure.","required":["type"],"example":{"type":"keep_email_domain"},"properties":{"type":{"type":"string","enum":["keep_year"],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.4","typeLabel":"KeepYear · object"},{"type":"object","title":"MaskEverything","description":"How a column's value is masked. Seven variants, each a JSON object tagged with `type`:\n\n- `keep_email_domain`: keeps the domain, plus the local part's first and last two characters\n (or just its first character when the local part is two to four characters long, and nothing\n at all when it is one character). A value with no `@`, or one that starts with `@` and so has\n no local part, is masked completely, domain included: `@example.com` masks to `************`.\n- `keep_initials`: replaces each whitespace-separated token with its first letter and three mask\n characters, whatever the token's length, so `John Doe` becomes `J*** D***`.\n- `keep_network_prefix`: keeps an IPv4 address's `/24` and masks the rest. Anything else, IPv6\n included, is masked completely.\n- `keep_two_decimal_places`: rounds a coordinate to two decimal places. A value that isn't a\n coordinate is masked completely.\n- `keep_year`: returns the first four-digit run in the value and drops the rest, so `1985-03-12`\n becomes `1985`. A value with no four-digit run is masked completely.\n- `keep_last_digits`: keeps the last `count` digits, masks every other letter and digit, and\n leaves separators alone so the value's shape survives. When the value has no other letter or\n digit to mask it keeps one digit fewer, so `1234` with `count: 4` masks to `*234`.\n- `mask_everything`: keeps nothing.\n\nOn write, an unrecognised `type` is rejected with a 400 and nothing is stored. The 400 names the\ncolumn it refused, the value it didn't recognise, and all seven types it accepts. Accepting the\ntypo and masking some other way instead would be worse than refusing: someone who typed\n`keep_emial_domain` would believe the domain was being kept, see fully-masked values, and get\nnothing telling them the strategy they asked for wasn't the one in use.\n\nBoth read endpoints answer 500 for a stored `masking_strategy` this API can't read, rather than\nnaming a strategy nobody wrote or masking by one. That 500 carries a `log_id` and not the column\nthat failed, so quote it when you report the failure.","required":["type"],"example":{"type":"keep_email_domain"},"properties":{"type":{"type":"string","enum":["mask_everything"],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.5","typeLabel":"MaskEverything · object"},{"type":"object","title":"KeepLastDigits","description":"How a column's value is masked. Seven variants, each a JSON object tagged with `type`:\n\n- `keep_email_domain`: keeps the domain, plus the local part's first and last two characters\n (or just its first character when the local part is two to four characters long, and nothing\n at all when it is one character). A value with no `@`, or one that starts with `@` and so has\n no local part, is masked completely, domain included: `@example.com` masks to `************`.\n- `keep_initials`: replaces each whitespace-separated token with its first letter and three mask\n characters, whatever the token's length, so `John Doe` becomes `J*** D***`.\n- `keep_network_prefix`: keeps an IPv4 address's `/24` and masks the rest. Anything else, IPv6\n included, is masked completely.\n- `keep_two_decimal_places`: rounds a coordinate to two decimal places. A value that isn't a\n coordinate is masked completely.\n- `keep_year`: returns the first four-digit run in the value and drops the rest, so `1985-03-12`\n becomes `1985`. A value with no four-digit run is masked completely.\n- `keep_last_digits`: keeps the last `count` digits, masks every other letter and digit, and\n leaves separators alone so the value's shape survives. When the value has no other letter or\n digit to mask it keeps one digit fewer, so `1234` with `count: 4` masks to `*234`.\n- `mask_everything`: keeps nothing.\n\nOn write, an unrecognised `type` is rejected with a 400 and nothing is stored. The 400 names the\ncolumn it refused, the value it didn't recognise, and all seven types it accepts. Accepting the\ntypo and masking some other way instead would be worse than refusing: someone who typed\n`keep_emial_domain` would believe the domain was being kept, see fully-masked values, and get\nnothing telling them the strategy they asked for wasn't the one in use.\n\nBoth read endpoints answer 500 for a stored `masking_strategy` this API can't read, rather than\nnaming a strategy nobody wrote or masking by one. That 500 carries a `log_id` and not the column\nthat failed, so quote it when you report the failure.","required":["type","count"],"example":{"type":"keep_email_domain","count":4},"properties":{"type":{"type":"string","enum":["keep_last_digits"],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.6.type","typeLabel":"enum\u003cstring>"},"count":{"description":"How many trailing digits survive. PCI practice keeps 4.","type":"integer","minimum":1,"maximum":4,"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.6.count","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy.oneOf.6","typeLabel":"KeepLastDigits · object"}],"isRequired":true,"uniqueKey":"columns.items.[INDEX].masking_strategy","typeLabel":"KeepEmailDomain · object | KeepInitials · object | KeepNetworkPrefix · object | KeepTwoDecimalPlaces · object | KeepYear · object | MaskEverything · object | KeepLastDigits · object"},"category":{"oneOf":[{"type":"string","description":"Optional on a redaction you upload: send `null` or leave the key out for a column you don't\nwant to classify. The privacy model sets it on the redactions it writes. Nothing masks by the\ncategory, only by `masking_strategy`, which is why the category may be left out and the\nstrategy may not. A stored redaction always returns the key, `null` for a column with no\ncategory.","enum":["account_number","other","private_address","private_date","private_email","private_person","private_phone","private_url","secret"],"example":"private_email","uniqueKey":"columns.items.[INDEX].category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Optional on a redaction you upload: send `null` or leave the key out for a column you don't\nwant to classify. The privacy model sets it on the redactions it writes. Nothing masks by the\ncategory, only by `masking_strategy`, which is why the category may be left out and the\nstrategy may not. A stored redaction always returns the key, `null` for a column with no\ncategory.","uniqueKey":"columns.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"uniqueKey":"columns.items.[INDEX].category","typeLabel":"enum\u003cstring> | null"}},"example":{"path":"email_address","category":"private_email","masking_strategy":{"type":"keep_email_domain"}},"uniqueKey":"columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"columns","typeLabel":"object[]"},"written_by":{"oneOf":[{"type":"object","title":"UserResourceOwner","description":"Who was authenticated when the redaction was written, taken from the access token rather than\nfrom anything the caller sent. One variant per kind of grant a token can carry, each tagged with\n`type`:\n\n- `user_resource_owner`: a token issued directly to a user of a company.\n- `app_installation`: a token issued to an app a company installed. `user_id` is null when the\n app issued itself the token rather than acting for a user.\n- `app_client_credentials`: a token issued to an app on its own credentials, which carries no\n user and no company.","required":["type","user_id","company_id"],"example":{"type":"user_resource_owner","user_id":4711,"company_id":42},"properties":{"type":{"type":"string","enum":["user_resource_owner"],"isRequired":true,"uniqueKey":"written_by.oneOf.0.type","typeLabel":"enum\u003cstring>"},"user_id":{"description":"The user the access token was issued to.","type":"integer","isRequired":true,"uniqueKey":"written_by.oneOf.0.user_id","typeLabel":"integer"},"company_id":{"description":"The company that user belongs to.","type":"integer","isRequired":true,"uniqueKey":"written_by.oneOf.0.company_id","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"written_by.oneOf.0","typeLabel":"UserResourceOwner · object"},{"type":"object","title":"AppInstallation","description":"Who was authenticated when the redaction was written, taken from the access token rather than\nfrom anything the caller sent. One variant per kind of grant a token can carry, each tagged with\n`type`:\n\n- `user_resource_owner`: a token issued directly to a user of a company.\n- `app_installation`: a token issued to an app a company installed. `user_id` is null when the\n app issued itself the token rather than acting for a user.\n- `app_client_credentials`: a token issued to an app on its own credentials, which carries no\n user and no company.","required":["type","user_id","company_id","app_id","installation_id"],"example":{"type":"user_resource_owner","user_id":4711,"company_id":42,"app_id":8,"installation_id":17},"properties":{"type":{"type":"string","enum":["app_installation"],"isRequired":true,"uniqueKey":"written_by.oneOf.1.type","typeLabel":"enum\u003cstring>"},"user_id":{"oneOf":[{"description":"The user the app was acting for, or null when the app issued itself the token.","type":"integer","isRequired":true,"uniqueKey":"written_by.oneOf.1.user_id.oneOf.0","typeLabel":"integer"},{"description":"The user the app was acting for, or null when the app issued itself the token.","type":"null","isRequired":true,"uniqueKey":"written_by.oneOf.1.user_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"written_by.oneOf.1.user_id","typeLabel":"integer | null"},"company_id":{"description":"The company that installed the app.","type":"integer","isRequired":true,"uniqueKey":"written_by.oneOf.1.company_id","typeLabel":"integer"},"app_id":{"description":"The installed app.","type":"integer","isRequired":true,"uniqueKey":"written_by.oneOf.1.app_id","typeLabel":"integer"},"installation_id":{"description":"That app's installation the token was issued against.","type":"integer","isRequired":true,"uniqueKey":"written_by.oneOf.1.installation_id","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"written_by.oneOf.1","typeLabel":"AppInstallation · object"},{"type":"object","title":"AppClientCredentials","description":"Who was authenticated when the redaction was written, taken from the access token rather than\nfrom anything the caller sent. One variant per kind of grant a token can carry, each tagged with\n`type`:\n\n- `user_resource_owner`: a token issued directly to a user of a company.\n- `app_installation`: a token issued to an app a company installed. `user_id` is null when the\n app issued itself the token rather than acting for a user.\n- `app_client_credentials`: a token issued to an app on its own credentials, which carries no\n user and no company.","required":["type","app_id"],"example":{"type":"user_resource_owner","app_id":8},"properties":{"type":{"type":"string","enum":["app_client_credentials"],"isRequired":true,"uniqueKey":"written_by.oneOf.2.type","typeLabel":"enum\u003cstring>"},"app_id":{"description":"The app the access token was issued to.","type":"integer","isRequired":true,"uniqueKey":"written_by.oneOf.2.app_id","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"written_by.oneOf.2","typeLabel":"AppClientCredentials · object"}],"isRequired":true,"uniqueKey":"written_by","typeLabel":"UserResourceOwner · object | AppInstallation · object | AppClientCredentials · object"},"model_version":{"oneOf":[{"description":"The privacy model that produced the redaction, named by the model repository the worker\nloaded. A deployment can point the worker at a different repository, so read the value rather\nthan expecting a fixed one.\n\nNull on a redaction you uploaded yourself: `PUT /datasets/{dataset_id}/redaction` refuses this\nfield from any caller but Narrative, and an upload that leaves it out clears a stored value.","type":"string","maxLength":128,"isRequired":true,"uniqueKey":"model_version.oneOf.0","typeLabel":"string"},{"description":"The privacy model that produced the redaction, named by the model repository the worker\nloaded. A deployment can point the worker at a different repository, so read the value rather\nthan expecting a fixed one.\n\nNull on a redaction you uploaded yourself: `PUT /datasets/{dataset_id}/redaction` refuses this\nfield from any caller but Narrative, and an upload that leaves it out clears a stored value.","type":"null","maxLength":128,"isRequired":true,"uniqueKey":"model_version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model_version","typeLabel":"string | null"},"created_at":{"description":"When the dataset's first redaction was written. Survives later uploads.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"When the redaction was last written or deleted.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"example":{"dataset_id":1234,"columns":[{"path":"email_address","category":"private_email","masking_strategy":{"type":"keep_email_domain"}},{"path":"payment.card_number","category":"account_number","masking_strategy":{"type":"keep_last_digits","count":4}}],"written_by":{"type":"app_installation","user_id":null,"company_id":42,"app_id":8,"installation_id":17},"model_version":"openai/privacy-filter","created_at":"2026-07-30T18:04:11Z","updated_at":"2026-07-30T18:04:11Z"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"dataset_id":1234,"columns":[{"path":"email_address","category":"private_email","masking_strategy":{"type":"keep_email_domain"}},{"path":"payment.card_number","category":"account_number","masking_strategy":{"type":"keep_last_digits","count":4}}],"written_by":{"type":"app_installation","user_id":null,"company_id":42,"app_id":8,"installation_id":17},"model_version":"openai/privacy-filter","created_at":"2026-07-30T18:04:11Z","updated_at":"2026-07-30T18:04:11Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"6c5d683b-525c-44e2-adee-84407b57437d":{"description":"Authentication token is malformed, invalid or insufficient permissions","content":{"application/json":{"schema":{"type":"object","required":["error","error_description"],"properties":{"error":{"type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_description":{"type":"string","example":"You are not authorized to use this endpoint.","isRequired":true,"uniqueKey":"error_description","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","error_description":"You are not authorized to use this endpoint."}}},"exampleType":"generated"}},"exampleType":"generated"},"ea36bb76-0325-407f-982c-4848b94861a4":{"description":"The request is not allowed with the token sent, or no valid token was sent.","content":{"application/json":{"schema":{"type":"object","required":["error","error_description"],"properties":{"error":{"type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"error_description":{"type":"string","example":"You are not authorized to use this endpoint.","isRequired":true,"uniqueKey":"error_description","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","error_description":"You are not authorized to use this endpoint."}}},"exampleType":"generated"}},"exampleType":"generated"},"d0dfb96c-a5a7-46ae-b61b-a7363ca61243":{"description":"The dataset was not found, or it has no redaction stored. Upload one via\n`PUT /datasets/{dataset_id}/redaction`, or ask the privacy model for one via\n`POST /v2/datasets/{dataset_id}/request-sample`. If you asked the privacy model and no redaction\nappeared, check that request's workflow run.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2c0ea981-ccf9-43e7-8408-ad5b152ebc43":{"description":"The stored redaction could not be read. The body is an RFC 7807 problem document. `title` is\n`Stored Redaction Unreadable`, `status` is `500`, `instance` is `/redaction`, and `detail` is always\n`The dataset's stored redaction could not be read. Provide the log_id for support.` `type`,\n`debug`, and `app` are null. Quote `log_id` when you report the failure.","content":{"application/json":{"schema":{"type":"object","description":"An RFC 7807 problem. `title` names the kind of error and `detail` explains this occurrence;\nhttps://docs.narrative.io/guides/nql/troubleshooting walks through the NQL titles.","required":["title","status","detail","instance","log_id"],"properties":{"title":{"type":"string","description":"a summary of the error","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"http status code","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"a longer description of the error","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","description":"path of the query","isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"log_id":{"type":"string","format":"uuid","description":"an internal logging id, Narrative can use to help debug a problem.","isRequired":true,"uniqueKey":"log_id","typeLabel":"string\u003cuuid>"},"type":{"oneOf":[{"description":"A URL naming the class of error.","type":"string","format":"uri","uniqueKey":"type.oneOf.0","typeLabel":"string\u003curi>"},{"description":"A URL naming the class of error.","type":"null","format":"uri","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string\u003curi> | null"},"debug":{"oneOf":[{"description":"Extra detail shaped by the error, for example the column and type name of an unsupported-type\nerror. Null when the error has nothing to add. Most errors only include it for admin tokens.","type":"object","additionalProperties":true,"uniqueKey":"debug.oneOf.0","typeLabel":"object"},{"description":"Extra detail shaped by the error, for example the column and type name of an unsupported-type\nerror. Null when the error has nothing to add. Most errors only include it for admin tokens.","type":"null","additionalProperties":true,"uniqueKey":"debug.oneOf.1","typeLabel":"null"}],"uniqueKey":"debug","typeLabel":"object | null"},"app":{"oneOf":[{"description":"The connector app that raised the error, on errors a connector returned. Otherwise null or absent.","type":"string","uniqueKey":"app.oneOf.0","typeLabel":"string"},{"description":"The connector app that raised the error, on errors a connector returned. Otherwise null or absent.","type":"null","uniqueKey":"app.oneOf.1","typeLabel":"null"}],"uniqueKey":"app","typeLabel":"string | null"}},"example":{"type":null,"title":"Failed to Parse Query","status":400,"detail":"Invalid query format.","instance":"/nql/validate","log_id":"c06fea02-0950-45c6-aaff-07ab07c0d04c","debug":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":null,"title":"Failed to Parse Query","status":400,"detail":"Invalid query format.","instance":"/nql/validate","log_id":"c06fea02-0950-45c6-aaff-07ab07c0d04c","debug":null}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"569c7eea-6609-4f11-9d87-306c36b9fb75":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"299d6b6f-9132-4667-be5b-3d7b5c2803c1":{"url":"https://api-dev.narrative.io"},"e3a3cbac-9bb0-44b5-a4b2-7a20ffe245c6":{"url":"https://api.narrative.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"https://docs-cdn.narrative.io/api-reference/main/openapi.json"},"subdomain":"narrative-07c7a1f7","siteName":"Narrative I/O Knowledge Base","title":"Get a dataset's sample redaction - Narrative I/O Knowledge Base","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T11:22:11.706Z","originalFileLocation":"api-reference/dataset-samples/get-a-datasets-sample-redaction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Return the stored redaction for a dataset\u0026#x27;s sample: which columns hold personal data, and how each is masked. Apply it with GET /datasets/{dataset_id}/sample/redacted. A redaction gets here one of two ways: you upload one with PUT /datasets/{dataset_id}/redaction, or Narrative\u0026#x27;s privacy model writes one. POST /v2/datasets/{dataset_id}/request-sample asks the model for one in a single call, and the GenerateSampleRedaction workflow task asks for the same thing as a step in a workflow of your own. model_version tells an uploaded redaction from a generated one.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Narrative I/O Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a dataset\u0026#x27;s sample redaction - Narrative I/O Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Return the stored redaction for a dataset\u0026#x27;s sample: which columns hold personal data, and how each is masked. Apply it with GET /datasets/{dataset_id}/sample/redacted. A redaction gets here one of two ways: you upload one with PUT /datasets/{dataset_id}/redaction, or Narrative\u0026#x27;s privacy model writes one. POST /v2/datasets/{dataset_id}/request-sample asks the model for one in a single call, and the GenerateSampleRedaction workflow task asks for the same thing as a step in a workflow of your own. model_version tells an uploaded redaction from a generated one.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Narrative I/O Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://narrative-07c7a1f7.mintlify.site/_mintlify/api/og/v2?division=Dataset+Samples\u0026amp;title=Get+a+dataset%27s+sample+redaction\u0026amp;description=Return+the+stored+redaction+for+a+dataset%27s+sample%3A+which+columns+hold+personal+data%2C+and+how%0Aeach+is+masked.+Apply+it+with+%60GET+%2Fdatasets%2F%7Bdataset_id%7D%2Fsample%2Fr\u0026amp;theme=ea22b67648b2d3a364e0af75\u0026amp;signature=d0b262a4108928017f1b9c20185a97a21ec223e3d703364e65adda121932112e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a dataset\u0026#x27;s sample redaction - Narrative I/O Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Return the stored redaction for a dataset\u0026#x27;s sample: which columns hold personal data, and how each is masked. Apply it with GET /datasets/{dataset_id}/sample/redacted. A redaction gets here one of two ways: you upload one with PUT /datasets/{dataset_id}/redaction, or Narrative\u0026#x27;s privacy model writes one. POST /v2/datasets/{dataset_id}/request-sample asks the model for one in a single call, and the GenerateSampleRedaction workflow task asks for the same thing as a step in a workflow of your own. model_version tells an uploaded redaction from a generated one.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://narrative-07c7a1f7.mintlify.site/_mintlify/api/og/v2?division=Dataset+Samples\u0026amp;title=Get+a+dataset%27s+sample+redaction\u0026amp;description=Return+the+stored+redaction+for+a+dataset%27s+sample%3A+which+columns+hold+personal+data%2C+and+how%0Aeach+is+masked.+Apply+it+with+%60GET+%2Fdatasets%2F%7Bdataset_id%7D%2Fsample%2Fr\u0026amp;theme=ea22b67648b2d3a364e0af75\u0026amp;signature=d0b262a4108928017f1b9c20185a97a21ec223e3d703364e65adda121932112e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/narrative-07c7a1f7/OOk68seBU2ePTAv6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Narrative I/O Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1438F5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/dataset-samples/get-a-datasets-sample-redaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.narrative.io/#organization\",\"name\":\"Narrative I/O Knowledge Base\",\"url\":\"https://docs.narrative.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/narrative-07c7a1f7/ia6SQX79O4nc7uYf/logo/banner.png?fit=max\u0026auto=format\u0026n=ia6SQX79O4nc7uYf\u0026q=85\u0026s=99860b25011c79366624a87d1f648861\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.narrative.io#website\",\"name\":\"Narrative I/O Knowledge Base\",\"url\":\"https://docs.narrative.io\",\"publisher\":{\"@id\":\"https://docs.narrative.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction#webpage\",\"url\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction\",\"name\":\"Get a dataset's sample redaction\",\"description\":\"Return the stored redaction for a dataset's sample: which columns hold personal data, and how each is masked. Apply it with GET /datasets/{dataset_id}/sample/redacted. A redaction gets here one of two ways: you upload one with PUT /datasets/{dataset_id}/redaction, or Narrative's privacy model writes one. POST /v2/datasets/{dataset_id}/request-sample asks the model for one in a single call, and the GenerateSampleRedaction workflow task asks for the same thing as a step in a workflow of your own. model_version tells an uploaded redaction from a generated one.\",\"dateModified\":\"2026-11-17T11:22:11.706Z\",\"isPartOf\":{\"@id\":\"https://docs.narrative.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dataset Samples\",\"item\":\"https://docs.narrative.io/api-reference/dataset-samples/sample-a-dataset\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a dataset's sample redaction\",\"item\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction#apireference\",\"headline\":\"Get a dataset's sample redaction\",\"name\":\"Get a dataset's sample redaction\",\"description\":\"Return the stored redaction for a dataset's sample: which columns hold personal data, and how each is masked. Apply it with GET /datasets/{dataset_id}/sample/redacted. A redaction gets here one of two ways: you upload one with PUT /datasets/{dataset_id}/redaction, or Narrative's privacy model writes one. POST /v2/datasets/{dataset_id}/request-sample asks the model for one in a single call, and the GenerateSampleRedaction workflow task asks for the same thing as a step in a workflow of your own. model_version tells an uploaded redaction from a generated one.\",\"url\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.narrative.io/api-reference/dataset-samples/get-a-datasets-sample-redaction#webpage\"},\"dateModified\":\"2026-11-17T11:22:11.706Z\",\"publisher\":{\"@id\":\"https://docs.narrative.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.narrative.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Narrative I/O Knowledge Base\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Narrative I/O Knowledge Base\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/dataset-samples/get-a-datasets-sample-redaction.md","siteName":"Narrative I/O Knowledge Base","nav":{"global":{"anchors":[{"anchor":"Release Notes","icon":"clock-rotate-left","href":"/release-notes"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/getting-started/create-account"}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/concepts"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/cookbooks"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference"}]},{"tab":"Connectors","pages":[{"title":"Connectors","href":"/reference/connectors"}]},{"tab":"NQL","pages":[{"title":"NQL","href":"/nql"}]},{"tab":"API Documentation","groups":[{"group":"Overview","pages":[{"title":"REST API","href":"/api-reference/introduction"}]},{"group":"Access Rules","pages":[{"title":"Get an Access Rule by id (V2)","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/access-rules/{access_rule_id}","href":"/api-reference/access-rules/get-an-access-rule-by-id-v2"},{"title":"Update an Access Rule by id (V2)","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /v2/access-rules/{access_rule_id}","href":"/api-reference/access-rules/update-an-access-rule-by-id-v2"},{"title":"Delete an access rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /v2/access-rules/{access_rule_id}","href":"/api-reference/access-rules/delete-an-access-rule"},{"title":"Get the query policy of an Access Rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/access-rules/{access_rule_id}/query-policy","href":"/api-reference/access-rules/get-the-query-policy-of-an-access-rule"},{"title":"Set the query policy of an Access Rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /v2/access-rules/{access_rule_id}/query-policy","href":"/api-reference/access-rules/set-the-query-policy-of-an-access-rule"},{"title":"Remove the query policy of an Access Rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /v2/access-rules/{access_rule_id}/query-policy","href":"/api-reference/access-rules/remove-the-query-policy-of-an-access-rule"},{"title":"Get an Access Rule by name (V2)","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/access-rules/{company_slug}/{access_rule_name}","href":"/api-reference/access-rules/get-an-access-rule-by-name-v2"},{"title":"Get all accessible Access Rules (V2)","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/access-rules","href":"/api-reference/access-rules/get-all-accessible-access-rules-v2"},{"title":"Create a new Access Rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/access-rules","href":"/api-reference/access-rules/create-a-new-access-rule"}]},{"group":"Access Tokens","pages":[{"title":"List Access Tokens","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /access-tokens/tokens","href":"/api-reference/access-tokens/list-access-tokens"},{"title":"Create Access Token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /access-tokens/tokens","href":"/api-reference/access-tokens/create-access-token"},{"title":"Get Access Token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /access-tokens/tokens/{access_token_id}","href":"/api-reference/access-tokens/get-access-token"},{"title":"Update Access Token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /access-tokens/tokens/{access_token_id}","href":"/api-reference/access-tokens/update-access-token"},{"title":"Delete Access Token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /access-tokens/tokens/{access_token_id}","href":"/api-reference/access-tokens/delete-access-token"},{"title":"Rotate Access Token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /access-tokens/tokens/{access_token_id}/rotate","href":"/api-reference/access-tokens/rotate-access-token"}]},{"group":"Agent Conversations","pages":[{"title":"List the calling user's agent conversations","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /agents/conversations","href":"/api-reference/agent-conversations/list-the-calling-users-agent-conversations"},{"title":"Create an agent conversation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /agents/conversations","href":"/api-reference/agent-conversations/create-an-agent-conversation"},{"title":"Get an agent conversation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /agents/conversations/{id}","href":"/api-reference/agent-conversations/get-an-agent-conversation"},{"title":"List conversation messages (delta read by version cursor)","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /agents/conversations/{id}/messages","href":"/api-reference/agent-conversations/list-conversation-messages-delta-read-by-version-cursor"},{"title":"Start a new run on the conversation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /agents/conversations/{id}/runs","href":"/api-reference/agent-conversations/start-a-new-run-on-the-conversation"},{"title":"Stop waiting on a handle","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /agents/conversations/{id}/waitables/{handle}/cancel","href":"/api-reference/agent-conversations/stop-waiting-on-a-handle"},{"title":"Get a run's current state","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /agents/runs/{id}","href":"/api-reference/agent-conversations/get-a-runs-current-state"}]},{"group":"App API","pages":[{"title":"Delivery Commands","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v1/app/commands/delivery","href":"/api-reference/app-api/delivery-commands"},{"title":"Delivery Files","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v1/app/commands/delivery/{delivery_id}/files","href":"/api-reference/app-api/delivery-files"},{"title":"Download file","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v1/app/commands/delivery/{delivery_id}/download/{filename}","href":"/api-reference/app-api/download-file"}]},{"group":"App Invites","pages":[{"title":"List App Invites","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /app-invites","href":"/api-reference/app-invites/list-app-invites"},{"title":"Create App Invite","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /app-invites","href":"/api-reference/app-invites/create-app-invite"},{"title":"Get App Invite","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /app-invites/{id}","href":"/api-reference/app-invites/get-app-invite"},{"title":"Archive App Invite","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /app-invites/{id}","href":"/api-reference/app-invites/archive-app-invite"},{"title":"Activate App Invite","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /app-invites/{id}/activate","href":"/api-reference/app-invites/activate-app-invite"},{"title":"Get App Invite By Code","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /app-invites/codes/{code}","href":"/api-reference/app-invites/get-app-invite-by-code"}]},{"group":"Apps","pages":[{"title":"Lists apps","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /apps","href":"/api-reference/apps/lists-apps"},{"title":"Publish app event","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /apps/events","href":"/api-reference/apps/publish-app-event"},{"title":"List installed app interfaces","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /apps/installed/interfaces","href":"/api-reference/apps/list-installed-app-interfaces"},{"title":"List app interfaces","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /apps/{app_id}/interfaces","href":"/api-reference/apps/list-app-interfaces"},{"title":"Get an app interface","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /apps/{app_id}/interfaces/{interface_id}","href":"/api-reference/apps/get-an-app-interface"},{"title":"Lists profiles","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /apps/{app_slug}/profiles","href":"/api-reference/apps/lists-profiles"},{"title":"Get an app's v1 manifest","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /apps/{app_slug}/manifest","href":"/api-reference/apps/get-an-apps-v1-manifest"},{"title":"List Apps","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/apps","href":"/api-reference/apps/list-apps"},{"title":"Create App","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/apps","href":"/api-reference/apps/create-app"},{"title":"Get App","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/apps/{slug}","href":"/api-reference/apps/get-app"},{"title":"Archive App","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /v2/apps/{slug}","href":"/api-reference/apps/archive-app"},{"title":"Replace App Manifest","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /v2/apps/{slug}/manifest","href":"/api-reference/apps/replace-app-manifest"},{"title":"Patch App Manifest","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json patch /v2/apps/{slug}/manifest","href":"/api-reference/apps/patch-app-manifest"},{"title":"Replace App Collaborators","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /v2/apps/{slug}/collaborators","href":"/api-reference/apps/replace-app-collaborators"},{"title":"Generate App Credentials","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/apps/{slug}/credentials/generate","href":"/api-reference/apps/generate-app-credentials"}]},{"group":"Attributes","pages":[{"title":"Get attributes","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /attributes","href":"/api-reference/attributes/get-attributes"},{"title":"Create an attribute","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /attributes","href":"/api-reference/attributes/create-an-attribute"},{"title":"Get an attribute","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /attributes/{attribute_name_or_id}","href":"/api-reference/attributes/get-an-attribute"},{"title":"Update an attribute","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /attributes/{attribute_name_or_id}","href":"/api-reference/attributes/update-an-attribute"},{"title":"Delete an attribute","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /attributes/{attribute_name_or_id}","href":"/api-reference/attributes/delete-an-attribute"},{"title":"Get attribute references.","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /attributes/{attribute_name_or_id}/references","href":"/api-reference/attributes/get-attribute-references"},{"title":"Get the derivation graph around an attribute.","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /attributes/{attribute_name_or_id}/derivation-graph","href":"/api-reference/attributes/get-the-derivation-graph-around-an-attribute"}]},{"group":"Auth","pages":[{"title":"Request or refresh an OAuth token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /oauth/token","href":"/api-reference/auth/request-or-refresh-an-oauth-token"}]},{"group":"Authentication","pages":[{"title":"Sign in with a Stytch B2B session token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /authentication/b2b/login","href":"/api-reference/authentication/sign-in-with-a-stytch-b2b-session-token"},{"title":"Register with a Stytch B2B session token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /authentication/b2b/register","href":"/api-reference/authentication/register-with-a-stytch-b2b-session-token"},{"title":"Check whether a Stytch B2B member is registered on Narrative","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /authentication/b2b/registration-status","href":"/api-reference/authentication/check-whether-a-stytch-b2b-member-is-registered-on-narrative"},{"title":"Exchange a user token for one scoped to another company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /authentication/exchange-token","href":"/api-reference/authentication/exchange-a-user-token-for-one-scoped-to-another-company"},{"title":"Sign in with a Stytch session token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /authentication/login","href":"/api-reference/authentication/sign-in-with-a-stytch-session-token"},{"title":"Register with a Stytch session token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /authentication/register","href":"/api-reference/authentication/register-with-a-stytch-session-token"},{"title":"Check whether a Stytch Magic Links or OAuth user is registered on Narrative","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /authentication/registration-status","href":"/api-reference/authentication/check-whether-a-stytch-magic-links-or-oauth-user-is-registered-on-narrative"}]},{"group":"Billings","pages":[{"title":"Get dataset storage billing","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /admin/billings/dataset-storage-billing","href":"/api-reference/billings/get-dataset-storage-billing"},{"title":"Get dataset storage billing for company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /billings/dataset-storage-billing","href":"/api-reference/billings/get-dataset-storage-billing-for-company"}]},{"group":"Companies","pages":[{"title":"Lists Company Domains","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /companies/{company_id}/domains","href":"/api-reference/companies/lists-company-domains"},{"title":"Get a presigned URL to upload company logo","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /admin/companies/logo-upload-url","href":"/api-reference/companies/get-a-presigned-url-to-upload-company-logo"}]},{"group":"Company","pages":[{"title":"Get a company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /companies/{company_id}","href":"/api-reference/company/get-a-company"},{"title":"Get a company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /company/{company_id}","href":"/api-reference/company/get-a-company-1"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /company/{company_id}","href":"/api-reference/company/update-a-company"},{"title":"Delete (archive) a company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /company/{company_id}","href":"/api-reference/company/delete-archive-a-company"},{"title":"Clear the company's default compute pool for a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /company/{company_id}/data-planes/{data_plane_id}/default-compute-pool","href":"/api-reference/company/clear-the-companys-default-compute-pool-for-a-data-plane"},{"title":"Set the company's default compute pool for a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /company/{company_id}/data-planes/{data_plane_id}/default-compute-pool/{compute_pool_id}","href":"/api-reference/company/set-the-companys-default-compute-pool-for-a-data-plane"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /users/{user_id}","href":"/api-reference/company/update-a-user"}]},{"group":"Company Marketing Information","pages":[{"title":"Returns the company and user associated with the token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /company-info/whoami","href":"/api-reference/company-marketing-information/returns-the-company-and-user-associated-with-the-token"},{"title":"Get marketing details on a company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /company-info/{company_id}","href":"/api-reference/company-marketing-information/get-marketing-details-on-a-company"}]},{"group":"Compute Pools","pages":[{"title":"List compute pools","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /data-planes/{data_plane_id}/compute-pools","href":"/api-reference/compute-pools/list-compute-pools"},{"title":"Create a compute pool","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /data-planes/{data_plane_id}/compute-pools","href":"/api-reference/compute-pools/create-a-compute-pool"},{"title":"Get a compute pool by ID","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /data-planes/{data_plane_id}/compute-pools/{compute_pool_id}","href":"/api-reference/compute-pools/get-a-compute-pool-by-id"},{"title":"Update a compute pool","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /data-planes/{data_plane_id}/compute-pools/{compute_pool_id}","href":"/api-reference/compute-pools/update-a-compute-pool"},{"title":"Archive a compute pool","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /data-planes/{data_plane_id}/compute-pools/{compute_pool_id}","href":"/api-reference/compute-pools/archive-a-compute-pool"}]},{"group":"Connections","pages":[{"title":"List connections","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/connections","href":"/api-reference/connections/list-connections"},{"title":"Create a connection","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/connections","href":"/api-reference/connections/create-a-connection"},{"title":"Get a connection","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/connections/{connection_id}","href":"/api-reference/connections/get-a-connection"},{"title":"Archive a connection","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /v2/connections/{connection_id}","href":"/api-reference/connections/archive-a-connection"}]},{"group":"Data Planes","pages":[{"title":"List data planes","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /data-planes","href":"/api-reference/data-planes/list-data-planes"},{"title":"Create a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /data-planes","href":"/api-reference/data-planes/create-a-data-plane"},{"title":"Get a data plane by ID","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /data-planes/{data_plane_id}","href":"/api-reference/data-planes/get-a-data-plane-by-id"},{"title":"Archive a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /data-planes/{data_plane_id}","href":"/api-reference/data-planes/archive-a-data-plane"},{"title":"Update a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json patch /data-planes/{data_plane_id}","href":"/api-reference/data-planes/update-a-data-plane"},{"title":"Data plane heartbeat","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /data-planes/{data_plane_id}/heartbeat","href":"/api-reference/data-planes/data-plane-heartbeat"},{"title":"Trigger a health check","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /data-planes/{data_plane_id}/health-check","href":"/api-reference/data-planes/trigger-a-health-check"},{"title":"Replace the collaborators on a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /data-planes/{data_plane_id}/collaborators","href":"/api-reference/data-planes/replace-the-collaborators-on-a-data-plane"},{"title":"Add a collaborator to a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /data-planes/{data_plane_id}/collaborators/{collaborator_company_id}","href":"/api-reference/data-planes/add-a-collaborator-to-a-data-plane"},{"title":"Remove a collaborator from a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /data-planes/{data_plane_id}/collaborators/{collaborator_company_id}","href":"/api-reference/data-planes/remove-a-collaborator-from-a-data-plane"},{"title":"Set the default compute pool for a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /data-planes/{data_plane_id}/default-compute-pool/{compute_pool_id}","href":"/api-reference/data-planes/set-the-default-compute-pool-for-a-data-plane"},{"title":"Clear the default compute pool for a data plane","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /data-planes/{data_plane_id}/default-compute-pool","href":"/api-reference/data-planes/clear-the-default-compute-pool-for-a-data-plane"}]},{"group":"Dataset Configuration","pages":[{"title":"Preview snapshot expirations","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/retention-policy/preview","href":"/api-reference/dataset-configuration/preview-snapshot-expirations"},{"title":"Upsert retention policies for a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}/retention-policy","href":"/api-reference/dataset-configuration/upsert-retention-policies-for-a-dataset"}]},{"group":"Dataset Files","pages":[{"title":"Files added","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/snapshots/{snapshot_id}/files-added","href":"/api-reference/dataset-files/files-added"},{"title":"Find snapshots","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/find-snapshots","href":"/api-reference/dataset-files/find-snapshots"},{"title":"Find files","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/find-files","href":"/api-reference/dataset-files/find-files"},{"title":"Issue file download url","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/snapshots/{snapshot_id}/files-added/{file_id}/download","href":"/api-reference/dataset-files/issue-file-download-url"}]},{"group":"Dataset Refresh","pages":[{"title":"Update the materialized view refresh configuration","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}/refresh-schedule","href":"/api-reference/dataset-refresh/update-the-materialized-view-refresh-configuration"},{"title":"Create a refresh schedule for an existing materialized view","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/refresh-schedule","href":"/api-reference/dataset-refresh/create-a-refresh-schedule-for-an-existing-materialized-view"},{"title":"Archive the materialized view refresh configuration","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /datasets/{dataset_id}/refresh-schedule","href":"/api-reference/dataset-refresh/archive-the-materialized-view-refresh-configuration"},{"title":"Run a materialized view refresh now","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/refresh-materialized-view","href":"/api-reference/dataset-refresh/run-a-materialized-view-refresh-now"}]},{"group":"Dataset Samples","pages":[{"title":"Sample a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/sample","href":"/api-reference/dataset-samples/sample-a-dataset"},{"title":"Upload a sample","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}/sample","href":"/api-reference/dataset-samples/upload-a-sample"},{"title":"Delete a sample","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /datasets/{dataset_id}/sample","href":"/api-reference/dataset-samples/delete-a-sample"},{"title":"Sample a dataset (Admin)","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/admin/sample","href":"/api-reference/dataset-samples/sample-a-dataset-admin"},{"title":"Request Dataset Sample","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/request-sample","href":"/api-reference/dataset-samples/request-dataset-sample"},{"title":"Sample a dataset and redact the sample","description":"Samples the dataset, then has Narrative's privacy model mark which columns of that sample hold\npersonal data and how each should be masked. Both steps run as one workflow.\n\nThe response is that workflow and the id of its run. Check the run with\n`GET /workflows/{workflow_id}/runs`; when it completes, read the model's decisions with\n`GET /datasets/{dataset_id}/redaction` and the masked rows with\n`GET /datasets/{dataset_id}/sample/redacted`. If the run fails, no redaction is stored and\n`GET /datasets/{dataset_id}/redaction` answers 404, as it does for any dataset without one. A run\nthat samples successfully and then fails to redact keeps the sample.\n\nEach call creates its own workflow.\n\nA body that cannot be decoded as `RequestSampleRequest` is treated as an empty body rather than\nrefused: a `compute_pool_id` that is not a UUID is ignored and the dataset's default compute pool is\nused.\n\n`POST /datasets/{dataset_id}/request-sample` samples without redacting and returns a job instead.\nTwo differences beyond the redaction step: this endpoint refuses a company over its credit limit\nwith a 403, and an invalid sample query fails the run rather than this request.","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/datasets/{dataset_id}/request-sample","href":"/api-reference/dataset-samples/sample-a-dataset-and-redact-the-sample"},{"title":"Get a dataset's sample redaction","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/redaction","href":"/api-reference/dataset-samples/get-a-datasets-sample-redaction"},{"title":"Upload a dataset's sample redaction","description":"Store the redaction for a dataset's sample, replacing whatever was there before. Uploading also\nbrings back a redaction that was previously deleted.\n\nTwo kinds of caller may upload: a customer with write access on datasets, or Narrative with admin\naccess on datasets. A customer's dataset is resolved inside their own company. Narrative's is\nresolved by id alone, with no company scoping, which is what lets Narrative write a redaction for\na customer's dataset.\n\nThe stored redaction records who wrote it from your access token, so a `written_by` field in the\nrequest body is ignored.\n\n`model_version` names the privacy model that produced a redaction, and only Narrative may set it.\nA customer sending it is refused with a 400 rather than dropped, so reading back a redaction\nNarrative generated and sending it straight here needs `model_version` removed first. An upload\nthat leaves the field out clears a stored value, so a redaction you edit stops claiming a model\nproduced it.","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}/redaction","href":"/api-reference/dataset-samples/upload-a-datasets-sample-redaction"},{"title":"Delete a dataset's sample redaction","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /datasets/{dataset_id}/redaction","href":"/api-reference/dataset-samples/delete-a-datasets-sample-redaction"},{"title":"Sample a dataset with its redaction applied","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/sample/redacted","href":"/api-reference/dataset-samples/sample-a-dataset-with-its-redaction-applied"},{"title":"Sampled Mappings","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/sample/mappings","href":"/api-reference/dataset-samples/sampled-mappings"}]},{"group":"Dataset Statistics","pages":[{"title":"Get Statistics Configuration","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/statistics-configuration","href":"/api-reference/dataset-statistics/get-statistics-configuration"},{"title":"Put Statistics Configuration","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}/statistics-configuration","href":"/api-reference/dataset-statistics/put-statistics-configuration"},{"title":"Disable Statistics Configuration","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /datasets/{dataset_id}/statistics-configuration","href":"/api-reference/dataset-statistics/disable-statistics-configuration"}]},{"group":"Datasets","pages":[{"title":"Get datasets","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets","href":"/api-reference/datasets/get-datasets"},{"title":"Create a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets","href":"/api-reference/datasets/create-a-dataset"},{"title":"Get a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}","href":"/api-reference/datasets/get-a-dataset"},{"title":"Update a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}","href":"/api-reference/datasets/update-a-dataset"},{"title":"Delete a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /datasets/{dataset_id}","href":"/api-reference/datasets/delete-a-dataset"},{"title":"Activate a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}/activate","href":"/api-reference/datasets/activate-a-dataset"},{"title":"Activate a dataset","deprecated":true,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/activate","href":"/api-reference/datasets/activate-a-dataset-1"},{"title":"Truncate a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/truncate","href":"/api-reference/datasets/truncate-a-dataset"},{"title":"Get admin info for a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/admin","href":"/api-reference/datasets/get-admin-info-for-a-dataset"},{"title":"Update a dataset's partition spec","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/admin/partition-spec","href":"/api-reference/datasets/update-a-datasets-partition-spec"},{"title":"Get dataset statistics","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/stats","href":"/api-reference/datasets/get-dataset-statistics"},{"title":"Get detailed statistics","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/column-stats","href":"/api-reference/datasets/get-detailed-statistics"},{"title":"Create or Update detailed statistics","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /datasets/{dataset_id}/column-stats","href":"/api-reference/datasets/create-or-update-detailed-statistics"},{"title":"Submit recalculation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/column-stats/recalculate","href":"/api-reference/datasets/submit-recalculation"},{"title":"Ingest a file","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/upload","href":"/api-reference/datasets/ingest-a-file"},{"title":"Issue an ingestion token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /datasets/{dataset_id}/upload/token","href":"/api-reference/datasets/issue-an-ingestion-token"},{"title":"List connector interfaces compatible with a dataset","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /datasets/{dataset_id}/interfaces","href":"/api-reference/datasets/list-connector-interfaces-compatible-with-a-dataset"}]},{"group":"Derivations","pages":[{"title":"Get derivation rules","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /derivations","href":"/api-reference/derivations/get-derivation-rules"},{"title":"Create a derivation rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /derivations","href":"/api-reference/derivations/create-a-derivation-rule"},{"title":"Get a derivation rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /derivations/{derivation_id}","href":"/api-reference/derivations/get-a-derivation-rule"},{"title":"Delete a derivation rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /derivations/{derivation_id}","href":"/api-reference/derivations/delete-a-derivation-rule"},{"title":"Update a derivation rule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json patch /derivations/{derivation_id}","href":"/api-reference/derivations/update-a-derivation-rule"}]},{"group":"Encryption Materials","pages":[{"title":"List encryption materials","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /encryption-materials","href":"/api-reference/encryption-materials/list-encryption-materials"},{"title":"Create an encryption material","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /encryption-materials","href":"/api-reference/encryption-materials/create-an-encryption-material"},{"title":"List decrypted encryption materials","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /encryption-materials/decrypted","href":"/api-reference/encryption-materials/list-decrypted-encryption-materials"},{"title":"Get an encryption material","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /encryption-materials/{encryption_material_id}","href":"/api-reference/encryption-materials/get-an-encryption-material"},{"title":"Update an encryption material","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /encryption-materials/{encryption_material_id}","href":"/api-reference/encryption-materials/update-an-encryption-material"},{"title":"Archive an encryption material","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /encryption-materials/{encryption_material_id}","href":"/api-reference/encryption-materials/archive-an-encryption-material"}]},{"group":"Installations","pages":[{"title":"List Installations","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /installations","href":"/api-reference/installations/list-installations"},{"title":"Create Installation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /installations","href":"/api-reference/installations/create-installation"},{"title":"Whoami Installation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /installations/whoami","href":"/api-reference/installations/whoami-installation"},{"title":"Get Installation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /installations/{id}","href":"/api-reference/installations/get-installation"},{"title":"Delete Installation","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /installations/{id}","href":"/api-reference/installations/delete-installation"},{"title":"Create Installation Token","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /installations/{id}/token","href":"/api-reference/installations/create-installation-token"}]},{"group":"Jobs","pages":[{"title":"Get jobs","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /jobs","href":"/api-reference/jobs/get-jobs"},{"title":"Get a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /jobs/{job_id}","href":"/api-reference/jobs/get-a-job"},{"title":"Run a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /jobs/{job_id}/run","href":"/api-reference/jobs/run-a-job"},{"title":"Schedule a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /jobs/{job_id}/schedule","href":"/api-reference/jobs/schedule-a-job"},{"title":"Complete a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /jobs/{job_id}/complete","href":"/api-reference/jobs/complete-a-job"},{"title":"Fail a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /jobs/{job_id}/fail","href":"/api-reference/jobs/fail-a-job"},{"title":"Request cancellation of a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /jobs/{job_id}/request-cancellation","href":"/api-reference/jobs/request-cancellation-of-a-job"},{"title":"Cancel a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /jobs/{job_id}/cancel","href":"/api-reference/jobs/cancel-a-job"},{"title":"Reschedule a job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /jobs/{job_id}/reschedule","href":"/api-reference/jobs/reschedule-a-job"}]},{"group":"Mappings","pages":[{"title":"Get mappings","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /mappings","href":"/api-reference/mappings/get-mappings"},{"title":"Get mapping","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /mappings/{mapping_id}","href":"/api-reference/mappings/get-mapping"},{"title":"Update a mapping","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /mappings/{mapping_id}","href":"/api-reference/mappings/update-a-mapping"},{"title":"Delete a mapping","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /mappings/{mapping_id}","href":"/api-reference/mappings/delete-a-mapping"},{"title":"Get mappings for a company","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /mappings/companies/{company_id}","href":"/api-reference/mappings/get-mappings-for-a-company"},{"title":"Create a mapping","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /mappings/companies/{company_id}","href":"/api-reference/mappings/create-a-mapping"},{"title":"Get mapping preview","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /mappings/{mapping_id}/sample","href":"/api-reference/mappings/get-mapping-preview"},{"title":"Test Mapping","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /mappings/test","href":"/api-reference/mappings/test-mapping"}]},{"group":"MCP Connections","pages":[{"title":"List the calling user's external MCP connections","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /mcp-connections","href":"/api-reference/mcp-connections/list-the-calling-users-external-mcp-connections"},{"title":"Begin connecting an external MCP server","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /mcp-connections","href":"/api-reference/mcp-connections/begin-connecting-an-external-mcp-server"},{"title":"OAuth redirect target that receives the authorization code","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /mcp-connections/callback","href":"/api-reference/mcp-connections/oauth-redirect-target-that-receives-the-authorization-code"},{"title":"Finish connecting an external MCP server","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /mcp-connections/complete","href":"/api-reference/mcp-connections/finish-connecting-an-external-mcp-server"},{"title":"Get one of the calling user's MCP connections","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /mcp-connections/{id}","href":"/api-reference/mcp-connections/get-one-of-the-calling-users-mcp-connections"},{"title":"Delete one of the calling user's MCP connections","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /mcp-connections/{id}","href":"/api-reference/mcp-connections/delete-one-of-the-calling-users-mcp-connections"}]},{"group":"Model Inference","pages":[{"title":"Run model inference","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /model-inference/run","href":"/api-reference/model-inference/run-model-inference"}]},{"group":"Model Training","pages":[{"title":"Fine-tune a model","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /model-training/run","href":"/api-reference/model-training/fine-tune-a-model"},{"title":"Train a classifier","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v1/model-training/train-classifier","href":"/api-reference/model-training/train-a-classifier"}]},{"group":"Models","pages":[{"title":"Get models","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /models","href":"/api-reference/models/get-models"},{"title":"Get a model","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /models/{model_id}","href":"/api-reference/models/get-a-model"},{"title":"Update a model","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /models/{model_id}","href":"/api-reference/models/update-a-model"},{"title":"Archive a model","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /models/{model_id}","href":"/api-reference/models/archive-a-model"}]},{"group":"NQL","pages":[{"title":"Validate an NQL statement","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /nql/validate","href":"/api-reference/nql/validate-an-nql-statement"},{"title":"Simulate an NQL query against access rules","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/nql/simulate","href":"/api-reference/nql/simulate-an-nql-query-against-access-rules"},{"title":"Parse an NQL statement","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /nql/parse","href":"/api-reference/nql/parse-an-nql-statement"},{"title":"Check Name Availability","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /nql/name-availability","href":"/api-reference/nql/check-name-availability"},{"title":"Execute an NQL statement","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v1/nql/execute","href":"/api-reference/nql/execute-an-nql-statement"},{"title":"Get a forecast job","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /nql/{job_id}","href":"/api-reference/nql/get-a-forecast-job"}]},{"group":"Permissions","pages":[{"title":"Create a permission","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /admin/permissions","href":"/api-reference/permissions/create-a-permission"}]},{"group":"Profiles","pages":[{"title":"Returns app profiles","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /installations/{installation_id}/profiles","href":"/api-reference/profiles/returns-app-profiles"},{"title":"Creates an app profile","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /installations/{installation_id}/profiles","href":"/api-reference/profiles/creates-an-app-profile"},{"title":"Returns profile with {profile_id}","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /installations/{installation_id}/profiles/{app_profile_id}","href":"/api-reference/profiles/returns-profile-with-"},{"title":"Updates an existing app profile","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /installations/{installation_id}/profiles/{app_profile_id}","href":"/api-reference/profiles/updates-an-existing-app-profile"},{"title":"Enables a profile","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /installations/{installation_id}/profiles/{app_profile_id}/enable","href":"/api-reference/profiles/enables-a-profile"},{"title":"Disables a profile","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /installations/{installation_id}/profiles/{app_profile_id}/disable","href":"/api-reference/profiles/disables-a-profile"},{"title":"Archives a profile","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /installations/{installation_id}/profiles/{app_profile_id}/archive","href":"/api-reference/profiles/archives-a-profile"}]},{"group":"Queries","pages":[{"title":"Get a query by id","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/queries/{query_id}","href":"/api-reference/queries/get-a-query-by-id"},{"title":"Deletes a query","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /v2/queries/{query_id}","href":"/api-reference/queries/deletes-a-query"},{"title":"Get accessible queries","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/queries","href":"/api-reference/queries/get-accessible-queries"},{"title":"Create a query","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/queries","href":"/api-reference/queries/create-a-query"}]},{"group":"Resources","pages":[{"title":"Get buckets","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /resources/buckets","href":"/api-reference/resources/get-buckets"},{"title":"Create bucket","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /resources/buckets","href":"/api-reference/resources/create-bucket"},{"title":"Update access type","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /resources/update-access","href":"/api-reference/resources/update-access-type"}]},{"group":"Schema Inference","pages":[{"title":"Infer the dataset schema of a file passed by multipart file.","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/inference","href":"/api-reference/schema-inference/infer-the-dataset-schema-of-a-file-passed-by-multipart-file"}]},{"group":"Uploads","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /uploads/{upload_path}","href":"/api-reference/uploads/upload-a-file"}]},{"group":"Usage","pages":[{"title":"Create a usage event","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /usage","href":"/api-reference/usage/create-a-usage-event"}]},{"group":"Views","pages":[{"title":"Get a view by id","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/views/{view_id}","href":"/api-reference/views/get-a-view-by-id"},{"title":"Updates a view","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json put /v2/views/{view_id}","href":"/api-reference/views/updates-a-view"},{"title":"Archives a view","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /v2/views/{view_id}","href":"/api-reference/views/archives-a-view"},{"title":"Get accessible views","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /v2/views","href":"/api-reference/views/get-accessible-views"},{"title":"Create a view","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /v2/views","href":"/api-reference/views/create-a-view"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /webhooks","href":"/api-reference/webhooks/create-a-webhook-subscription"},{"title":"Get a webhook subscription by ID","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /webhooks/{webhook_subscription_id}","href":"/api-reference/webhooks/get-a-webhook-subscription-by-id"},{"title":"Archive a webhook subscription","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /webhooks/{webhook_subscription_id}","href":"/api-reference/webhooks/archive-a-webhook-subscription"},{"title":"Event delivery","version":null,"deprecated":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json webhook webhookDelivery","href":"/api-reference/webhooks/event-delivery"}]},{"group":"Whoami","pages":[{"title":"Get a current user","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /whoami","href":"/api-reference/whoami/get-a-current-user"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create a workflow","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"Get a workflow","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /workflows/{workflow_id}","href":"/api-reference/workflows/get-a-workflow"},{"title":"Archive a workflow","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /workflows/{workflow_id}","href":"/api-reference/workflows/archive-a-workflow"},{"title":"Trigger a workflow","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /workflows/{workflow_id}/trigger","href":"/api-reference/workflows/trigger-a-workflow"},{"title":"Schedule a workflow","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /workflows/{workflow_id}/schedule","href":"/api-reference/workflows/schedule-a-workflow"},{"title":"Remove a workflow schedule","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json delete /workflows/{workflow_id}/schedule","href":"/api-reference/workflows/remove-a-workflow-schedule"},{"title":"Cancel a workflow execution","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /workflows/{workflow_id}/cancel","href":"/api-reference/workflows/cancel-a-workflow-execution"},{"title":"List workflow runs","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json get /workflows/{workflow_id}/runs","href":"/api-reference/workflows/list-workflow-runs"},{"title":"Cancel a specific workflow run","deprecated":null,"version":null,"openapi":"https://docs-cdn.narrative.io/api-reference/main/openapi.json post /workflows/{workflow_id}/runs/{run_id}/cancel","href":"/api-reference/workflows/cancel-a-specific-workflow-run"}]}]}]},"basePath":"","title":"Get a dataset's sample redaction - Narrative I/O Knowledge Base","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}