{
"error": "Authorization header with a bearer token is required"
}
{
"error": "template with key: \"invoice-template\" already exists"
}
{
"error": "server error"
}
Templates
Create template
Create a new draft template. Returns 402 if a template with the same key already exists (use PATCH /templates/{key} to update an existing draft).
The source object references a DOCX file already uploaded to microstrate-documents object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. {client_name}, {#line_items}…{/line_items}, {subtotal + tax}) are evaluated against the trigger payload to produce the final output — a PDF when output.content_type is application/pdf, or a rendered DOCX.
Other expression-aware fields:
output.name — output filename template, e.g. invoice-{invoice_number}; the extension (.pdf/.docx) is appended automatically based on output.content_type.
signatories[].name / signatories[].email — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped.
sub_templates[].conditions — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template.
It is recommended to run POST /templates/validate on the DOCX content first to catch malformed tags.
{
"error": "Authorization header with a bearer token is required"
}
{
"error": "template with key: \"invoice-template\" already exists"
}
{
"error": "server error"
}
Authorizations
bearerAuthapiKeyAuth
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Request body for creating or updating a template.
key
string
required
Unique identifier for the template.
Example:
"invoice-template"
label
string
Human-readable display name.
Example:
"Standard Invoice"
source
object
Reference to the source template file in object storage (the document object store bucket). DOCX sources are processed with the angular expression parser: tags such as {client_name}, {#items}…{/items} (loops), {price + tax} (operators), and {amount | formatcurrency:'EUR'} (filters) are evaluated against the trigger payload to produce the final output. PDF sources (application/pdf) are passed through — and merged with sub-templates — without expression rendering, and can only output PDF.
Show child attributes
output
object
Where and how the rendered document is written. The final storage key is {bucket}/{folder}/{name}.{ext} with the extension derived from content_type.
Show child attributes
signatories
object[]
Signatories to request e-signatures from once the document is generated. name and email support expression placeholders resolved against the trigger payload; entries whose rendered email is missing or invalid are skipped. An empty/absent array means no signature request is sent.
Show child attributes
sub_templates
object[]
Additional published templates rendered with the same payload and merged after the main template in array order. Entries with conditions are included only when the rule-engine conditions evaluate to true against the trigger payload.
Show child attributes
Response
Template created successfully.
subject
string
Messaging subject of the created or updated record. Formats: draft template ms.document.draft.template.{key}, published template ms.document.template.{key}, document ms.document.document.{key} — with keys sanitised into subject tokens (/ → ., spaces → _, other special characters → uXXXX codes).
Example:
"ms.document.draft.template.invoice-template"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"QuivaWorks Docs","description":"","colors":{"primary":"#4641F2","light":"#ffffff","dark":"#4641F2"},"logo":{"light":"https://mintcdn.com/microstrate/Eit-IsSh6_6H8X4Q/logo/light.svg?fit=max\u0026auto=format\u0026n=Eit-IsSh6_6H8X4Q\u0026q=85\u0026s=01f10191a8ee36765af69b1436deb5e0","dark":"https://mintcdn.com/microstrate/Eit-IsSh6_6H8X4Q/logo/dark.svg?fit=max\u0026auto=format\u0026n=Eit-IsSh6_6H8X4Q\u0026q=85\u0026s=9dc23bd7a296bc325260ff32d2fc6d17"},"favicon":"https://mintcdn.com/microstrate/bn6ONmpX3KvP6AZn/favicon.svg?fit=max\u0026auto=format\u0026n=bn6ONmpX3KvP6AZn\u0026q=85\u0026s=af71ce7c16b2da43ee49a98290989182","appearance":{"default":"system"},"navbar":{"links":[{"href":"https://app.quiva.ai/en/login","label":"Log in"}],"primary":{"type":"button","label":"Try for free","href":"https://app.quiva.ai/en/signup"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/quivaworks"}},"fonts":{"family":"Be Vietnam Pro"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://quiva.ai/community"},{"anchor":"Support","icon":"headset","href":"https://quiva.ai/help-center/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"microstrate","hasAudioNarration":false,"actualSubdomain":"microstrate","customDomains":["docs.quiva.ai"],"gitSource":{"type":"github","owner":"quivaworks","repo":"quiva.ai","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b01a150bc9bec18ba0f1ea3","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":650},{"language":"default","tag":"Accounts","count":154},{"language":"default","tag":"Guides","count":129},{"language":"default","tag":"Records","count":84},{"language":"default","tag":"Assistants","count":83},{"language":"default","tag":"Workspaces","count":80},{"language":"default","tag":"Hub Flows","count":63},{"language":"default","tag":"Documents","count":52},{"language":"default","tag":"Abbie","count":48},{"language":"default","tag":"Spaces","count":44}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"site-roles","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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/templates/create-template","slug":"/api-reference/templates/create-template","pageMetadata":{"title":"Create template","description":"Create a new **draft** template. Returns `402` if a template with the same key already exists (use `PATCH /templates/{key}` to update an existing draft).\n\nThe `source` object references a DOCX file already uploaded to `microstrate-documents` object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. `{client_name}`, `{#line_items}…{/line_items}`, `{subtotal + tax}`) are evaluated against the trigger payload to produce the final output — a PDF when `output.content_type` is `application/pdf`, or a rendered DOCX. \n\nOther expression-aware fields:\n- `output.name` — output filename template, e.g. `invoice-{invoice_number}`; the extension (`.pdf`/`.docx`) is appended automatically based on `output.content_type`.\n- `signatories[].name` / `signatories[].email` — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped.\n- `sub_templates[].conditions` — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template.\n\nIt is recommended to run `POST /templates/validate` on the DOCX content first to catch malformed tags.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates","href":"/api-reference/templates/create-template","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 li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Create a new \", _jsx(_components.strong, {\n children: \"draft\"\n }), \" template. Returns \", _jsx(_components.code, {\n children: \"402\"\n }), \" if a template with the same key already exists (use \", _jsx(_components.code, {\n children: \"PATCH /templates/{key}\"\n }), \" to update an existing draft).\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"source\"\n }), \" object references a DOCX file already uploaded to \", _jsx(_components.code, {\n children: \"microstrate-documents\"\n }), \" object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. \", _jsx(_components.code, {\n children: \"{client_name}\"\n }), \", \", _jsx(_components.code, {\n children: \"{#line_items}…{/line_items}\"\n }), \", \", _jsx(_components.code, {\n children: \"{subtotal + tax}\"\n }), \") are evaluated against the trigger payload to produce the final output — a PDF when \", _jsx(_components.code, {\n children: \"output.content_type\"\n }), \" is \", _jsx(_components.code, {\n children: \"application/pdf\"\n }), \", or a rendered DOCX.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Other expression-aware fields:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"output.name\"\n }), \" — output filename template, e.g. \", _jsx(_components.code, {\n children: \"invoice-{invoice_number}\"\n }), \"; the extension (\", _jsx(_components.code, {\n children: \".pdf\"\n }), \"/\", _jsx(_components.code, {\n children: \".docx\"\n }), \") is appended automatically based on \", _jsx(_components.code, {\n children: \"output.content_type\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"signatories[].name\"\n }), \" / \", _jsx(_components.code, {\n children: \"signatories[].email\"\n }), \" — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"sub_templates[].conditions\"\n }), \" — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"It is recommended to run \", _jsx(_components.code, {\n children: \"POST /templates/validate\"\n }), \" on the DOCX content first to catch malformed tags.\"]\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":"Create template","description":"Create a new **draft** template. Returns `402` if a template with the same key already exists (use `PATCH /templates/{key}` to update an existing draft).\n\nThe `source` object references a DOCX file already uploaded to `microstrate-documents` object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. `{client_name}`, `{#line_items}…{/line_items}`, `{subtotal + tax}`) are evaluated against the trigger payload to produce the final output — a PDF when `output.content_type` is `application/pdf`, or a rendered DOCX. \n\nOther expression-aware fields:\n- `output.name` — output filename template, e.g. `invoice-{invoice_number}`; the extension (`.pdf`/`.docx`) is appended automatically based on `output.content_type`.\n- `signatories[].name` / `signatories[].email` — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped.\n- `sub_templates[].conditions` — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template.\n\nIt is recommended to run `POST /templates/validate` on the DOCX content first to catch malformed tags.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates","href":"/api-reference/templates/create-template","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Templates"],"summary":"Create template","description":"Create a new **draft** template. Returns `402` if a template with the same key already exists (use `PATCH /templates/{key}` to update an existing draft).\n\nThe `source` object references a DOCX file already uploaded to `microstrate-documents` object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. `{client_name}`, `{#line_items}…{/line_items}`, `{subtotal + tax}`) are evaluated against the trigger payload to produce the final output — a PDF when `output.content_type` is `application/pdf`, or a rendered DOCX. \n\nOther expression-aware fields:\n- `output.name` — output filename template, e.g. `invoice-{invoice_number}`; the extension (`.pdf`/`.docx`) is appended automatically based on `output.content_type`.\n- `signatories[].name` / `signatories[].email` — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped.\n- `sub_templates[].conditions` — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template.\n\nIt is recommended to run `POST /templates/validate` on the DOCX content first to catch malformed tags.","operationId":"createTemplate","x-resource-type":"service","requestBody":"e0f872d4-997b-4228-ab14-8a625b81e6a4","responses":{"200":"95c94ef3-c167-428a-8002-fd7da7077551","400":"f861c498-1679-4868-b28f-c11b49154694","401":"4e4f6212-3e87-442e-8f9f-fae1f734706a","402":"d1b1b615-3757-4a7e-8a83-6ed25a3c702d","500":"24d60624-9fe6-4335-a1f1-a046f187c907"},"method":"post","type":"path","servers":["edc69c7d-ed33-46eb-9b77-4760f4155ae1"],"security":["89d46ef0-0d72-4c3f-bb26-62f25c65a9bd","28a59d7d-d218-4ebf-b71c-1649d165e864"],"path":"/file-generator/templates","baseUrlOptions":["https://api.quiva.ai"],"title":"Create template","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating or updating a template.","required":["key"],"properties":{"key":{"type":"string","description":"Unique identifier for the template.","example":"invoice-template","isRequired":true,"uniqueKey":"key","typeLabel":"string"},"label":{"type":"string","description":"Human-readable display name.","example":"Standard Invoice","uniqueKey":"label","typeLabel":"string"},"source":{"type":"object","required":["key","content_type"],"description":"Reference to the source template file in object storage (the document object store bucket). DOCX sources are processed with the angular expression parser: tags such as `{client_name}`, `{#items}…{/items}` (loops), `{price + tax}` (operators), and `{amount | formatcurrency:'EUR'}` (filters) are evaluated against the trigger payload to produce the final output. PDF sources (`application/pdf`) are passed through — and merged with sub-templates — without expression rendering, and can only output PDF.","properties":{"key":{"type":"string","description":"Template file reference. Either a simple path (uses default `microstrate-documents` bucket) or a full storage URL. Formats: `templates/invoice.docx` (default) | `obj://bucket-name/path/file.docx` (object store) | `kv://bucket-name/path/file.docx` (key-value store).","examples":["templates/invoice.docx","obj://microstrate-documents/templates/invoice.docx","obj://external-bucket/templates/contract.docx"],"isRequired":true,"uniqueKey":"source.key","typeLabel":"string"},"content_type":{"type":"string","description":"MIME type of the source file.","example":"application/vnd.openxmlformats-officedocument.wordprocessingml.document","isRequired":true,"uniqueKey":"source.content_type","typeLabel":"string"}},"uniqueKey":"source","typeLabel":"object"},"output":{"type":"object","properties":{"name":{"type":"string","description":"Output filename template, rendered against the trigger payload with single-brace angular expressions (e.g. `invoice-{invoice_number}` → `invoice-INV-2026-014`). Defaults to the template key when omitted or when rendering fails. The `.pdf`/`.docx` extension is appended automatically from `content_type` — do not include it.","example":"invoice-{invoice_number}","uniqueKey":"output.name","typeLabel":"string"},"content_type":{"type":"string","description":"Output MIME type. DOCX sources can render to PDF or DOCX; PDF sources can only output PDF (PDF→DOCX conversion is not supported).","enum":["application/pdf","application/vnd.openxmlformats-officedocument.wordprocessingml.document"],"example":"application/pdf","uniqueKey":"output.content_type","typeLabel":"enum\u003cstring>"},"bucket":{"type":"string","description":"Storage bucket. May be prefixed with `obj://` (object store, default) or `kv://` (key-value store) to select the storage backend. Defaults to the service's document bucket.","example":"microstrate-documents","uniqueKey":"output.bucket","typeLabel":"string"},"folder":{"type":"string","description":"Output folder path within the bucket.","example":"invoices/2024","uniqueKey":"output.folder","typeLabel":"string"}},"description":"Where and how the rendered document is written. The final storage key is `{bucket}/{folder}/{name}.{ext}` with the extension derived from `content_type`.","uniqueKey":"output","typeLabel":"object"},"signatories":{"type":"array","items":{"type":"object","required":["name","email","validity"],"properties":{"name":{"type":"string","description":"Signatory name. Supports single-brace angular expression placeholders resolved against the trigger payload, e.g. `{client_name}`. The rendered value is trimmed and truncated to 100 characters (HelloSign limit).","example":"{client_name}","isRequired":true,"uniqueKey":"signatories.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","description":"Signatory email. Supports single-brace angular expression placeholders resolved against the trigger payload, e.g. `{client_email}`. The rendered value is trimmed and lowercased; signatories with a missing or invalid rendered email (or empty name) are skipped — if none remain, no signature request is sent and the document's `signatures` is `null`.","example":"{client_email}","isRequired":true,"uniqueKey":"signatories.items.[INDEX].email","typeLabel":"string"},"validity":{"type":"object","description":"How long the signatory has to complete signing, measured from when the signature request is sent. The day/week/month/year components are summed; once elapsed, the signature is marked `EXPIRED` and the HelloSign request is cancelled.","properties":{"day":{"type":"integer","example":7,"uniqueKey":"signatories.items.[INDEX].validity.day","typeLabel":"integer"},"week":{"type":"integer","example":0,"uniqueKey":"signatories.items.[INDEX].validity.week","typeLabel":"integer"},"month":{"type":"integer","example":0,"uniqueKey":"signatories.items.[INDEX].validity.month","typeLabel":"integer"},"year":{"type":"integer","example":0,"uniqueKey":"signatories.items.[INDEX].validity.year","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"signatories.items.[INDEX].validity","typeLabel":"object"},"order":{"type":"integer","description":"Signing order index (0-based). Defaults to the signatory's position in the array.","example":0,"uniqueKey":"signatories.items.[INDEX].order","typeLabel":"integer"}},"uniqueKey":"signatories.items.[INDEX]","typeLabel":"object"},"description":"Signatories to request e-signatures from once the document is generated. `name` and `email` support expression placeholders resolved against the trigger payload; entries whose rendered email is missing or invalid are skipped. An empty/absent array means no signature request is sent.","uniqueKey":"signatories","typeLabel":"object[]"},"sub_templates":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"Key of the sub-template to merge.","example":"terms-and-conditions","isRequired":true,"uniqueKey":"sub_templates.items.[INDEX].key","typeLabel":"string"},"conditions":{"type":"object","additionalProperties":true,"description":"Rule-engine condition object evaluated against the trigger payload; the sub-template is only included when it resolves to true. Payload keys are exposed as facts named `\u003ckey>.value` (e.g. payload `client_region` → fact `client_region.value`).","example":{"all":[{"fact":"client_region.value","operator":"equal","value":"EU"}]},"uniqueKey":"sub_templates.items.[INDEX].conditions","typeLabel":"object"}},"uniqueKey":"sub_templates.items.[INDEX]","typeLabel":"object"},"description":"Additional published templates rendered with the same payload and merged after the main template in array order. Entries with `conditions` are included only when the rule-engine conditions evaluate to true against the trigger payload.","uniqueKey":"sub_templates","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"key":"invoice-template","label":"Standard Invoice","source":{"key":"invoice.docx","content_type":"application/vnd.openxmlformats-officedocument.wordprocessingml.document"},"output":{"name":"invoice-{invoice_number}","content_type":"application/pdf","bucket":"microstrate-documents","folder":"invoices"},"signatories":[{"name":"{client_name}","email":"{client_email}","validity":{"day":7},"order":0}]},"examples":{"Example":{"title":"Example","value":{"key":"invoice-template","label":"Standard Invoice","source":{"key":"invoice.docx","content_type":"application/vnd.openxmlformats-officedocument.wordprocessingml.document"},"output":{"name":"invoice-{invoice_number}","content_type":"application/pdf","bucket":"microstrate-documents","folder":"invoices"},"signatories":[{"name":"{client_name}","email":"{client_email}","validity":{"day":7},"order":0}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"95c94ef3-c167-428a-8002-fd7da7077551":{"description":"Template created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"Messaging subject of the created or updated record. Formats: draft template `ms.document.draft.template.{key}`, published template `ms.document.template.{key}`, document `ms.document.document.{key}` — with keys sanitised into subject tokens (`/` → `.`, spaces → `_`, other special characters → `uXXXX` codes).","example":"ms.document.draft.template.invoice-template","uniqueKey":"subject","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"subject":"ms.document.draft.template.invoice-template"},"examples":{"Example":{"title":"Example","value":{"subject":"ms.document.draft.template.invoice-template"}}},"exampleType":"examples"}},"exampleType":"examples"},"f861c498-1679-4868-b28f-c11b49154694":{"description":"Invalid or missing request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"\"key\" is required","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"\"key\" is required"},"examples":{"Example":{"title":"Example","value":{"error":"\"key\" is required"}}},"exampleType":"examples"}},"exampleType":"examples"},"4e4f6212-3e87-442e-8f9f-fae1f734706a":{"description":"Missing or invalid Authorization header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"\"key\" is required","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Authorization header with a bearer token is required"},"examples":{"Example":{"title":"Example","value":{"error":"Authorization header with a bearer token is required"}}},"exampleType":"examples"}},"exampleType":"examples"},"d1b1b615-3757-4a7e-8a83-6ed25a3c702d":{"description":"Template with this key already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"\"key\" is required","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"template with key: \"invoice-template\" already exists"},"examples":{"Example":{"title":"Example","value":{"error":"template with key: \"invoice-template\" already exists"}}},"exampleType":"examples"}},"exampleType":"examples"},"24d60624-9fe6-4335-a1f1-a046f187c907":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"\"key\" is required","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"server error"},"examples":{"Example":{"title":"Example","value":{"error":"server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"89d46ef0-0d72-4c3f-bb26-62f25c65a9bd":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}},"28a59d7d-d218-4ebf-b71c-1649d165e864":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"edc69c7d-ed33-46eb-9b77-4760f4155ae1":{"url":"https://api.quiva.ai","description":"Production API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","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"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/endpoint/documents/openapi.json"},"subdomain":"microstrate","siteName":"QuivaWorks Docs","title":"Create template - QuivaWorks Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T13:49:23.381Z","originalFileLocation":"api-reference/templates/create-template.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=\"Create a new draft template. Returns 402 if a template with the same key already exists (use PATCH /templates/{key} to update an existing draft). The source object references a DOCX file already uploaded to microstrate-documents object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. {client_name}, {#line_items}…{/line_items}, {subtotal + tax}) are evaluated against the trigger payload to produce the final output — a PDF when output.content_type is application/pdf, or a rendered DOCX. Other expression-aware fields: - output.name — output filename template, e.g. invoice-{invoice_number}; the extension (.pdf/.docx) is appended automatically based on output.content_type. - signatories[].name / signatories[].email — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped. - sub_templates[].conditions — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template. It is recommended to run POST /templates/validate on the DOCX content first to catch malformed tags.\">\u003cmeta data-mint-head name=\"application-name\" content=\"QuivaWorks Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_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/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_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/microstrate/rkD4iFTLdo_icBn3/_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/microstrate/rkD4iFTLdo_icBn3/_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/microstrate/rkD4iFTLdo_icBn3/_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/microstrate/rkD4iFTLdo_icBn3/_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/microstrate/rkD4iFTLdo_icBn3/_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/microstrate/rkD4iFTLdo_icBn3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create template - QuivaWorks Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new draft template. Returns 402 if a template with the same key already exists (use PATCH /templates/{key} to update an existing draft). The source object references a DOCX file already uploaded to microstrate-documents object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. {client_name}, {#line_items}…{/line_items}, {subtotal + tax}) are evaluated against the trigger payload to produce the final output — a PDF when output.content_type is application/pdf, or a rendered DOCX. Other expression-aware fields: - output.name — output filename template, e.g. invoice-{invoice_number}; the extension (.pdf/.docx) is appended automatically based on output.content_type. - signatories[].name / signatories[].email — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped. - sub_templates[].conditions — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template. It is recommended to run POST /templates/validate on the DOCX content first to catch malformed tags.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"QuivaWorks Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.quiva.ai/api-reference/templates/create-template\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://microstrate.mintlify.site/_mintlify/api/og/v2?division=Templates\u0026amp;title=Create+template\u0026amp;description=Create+a+new+**draft**+template.+Returns+%60402%60+if+a+template+with+the+same+key+already+exists+%28use+%60PATCH+%2Ftemplates%2F%7Bkey%7D%60+to+update+an+existing+draft%29.%0A%0AThe+%60\u0026amp;theme=749a3bdf44d0afc15e32a17f\u0026amp;signature=39d18fab1fe03569c40649d0ad7b56c50e928b6cb33aed5b3a5f68a0f0e917cc\">\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=\"Create template - QuivaWorks Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new draft template. Returns 402 if a template with the same key already exists (use PATCH /templates/{key} to update an existing draft). The source object references a DOCX file already uploaded to microstrate-documents object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. {client_name}, {#line_items}…{/line_items}, {subtotal + tax}) are evaluated against the trigger payload to produce the final output — a PDF when output.content_type is application/pdf, or a rendered DOCX. Other expression-aware fields: - output.name — output filename template, e.g. invoice-{invoice_number}; the extension (.pdf/.docx) is appended automatically based on output.content_type. - signatories[].name / signatories[].email — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped. - sub_templates[].conditions — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template. It is recommended to run POST /templates/validate on the DOCX content first to catch malformed tags.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://microstrate.mintlify.site/_mintlify/api/og/v2?division=Templates\u0026amp;title=Create+template\u0026amp;description=Create+a+new+**draft**+template.+Returns+%60402%60+if+a+template+with+the+same+key+already+exists+%28use+%60PATCH+%2Ftemplates%2F%7Bkey%7D%60+to+update+an+existing+draft%29.%0A%0AThe+%60\u0026amp;theme=749a3bdf44d0afc15e32a17f\u0026amp;signature=39d18fab1fe03569c40649d0ad7b56c50e928b6cb33aed5b3a5f68a0f0e917cc\">\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/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"QuivaWorks Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4641F2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.quiva.ai/api-reference/templates/create-template\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/templates/create-template.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.quiva.ai/#organization\",\"name\":\"QuivaWorks Docs\",\"url\":\"https://docs.quiva.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/microstrate/Eit-IsSh6_6H8X4Q/logo/light.svg?fit=max\u0026auto=format\u0026n=Eit-IsSh6_6H8X4Q\u0026q=85\u0026s=01f10191a8ee36765af69b1436deb5e0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.quiva.ai#website\",\"name\":\"QuivaWorks Docs\",\"url\":\"https://docs.quiva.ai\",\"publisher\":{\"@id\":\"https://docs.quiva.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.quiva.ai/api-reference/templates/create-template#webpage\",\"url\":\"https://docs.quiva.ai/api-reference/templates/create-template\",\"name\":\"Create template\",\"description\":\"Create a new draft template. Returns 402 if a template with the same key already exists (use PATCH /templates/{key} to update an existing draft). The source object references a DOCX file already uploaded to microstrate-documents object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. {client_name}, {#line_items}…{/line_items}, {subtotal + tax}) are evaluated against the trigger payload to produce the final output — a PDF when output.content_type is application/pdf, or a rendered DOCX. Other expression-aware fields: - output.name — output filename template, e.g. invoice-{invoice_number}; the extension (.pdf/.docx) is appended automatically based on output.content_type. - signatories[].name / signatories[].email — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped. - sub_templates[].conditions — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template. It is recommended to run POST /templates/validate on the DOCX content first to catch malformed tags.\",\"dateModified\":\"2026-11-21T13:49:23.381Z\",\"isPartOf\":{\"@id\":\"https://docs.quiva.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.quiva.ai/api-reference/templates/create-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.quiva.ai/api-reference/templates/create-template#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documents\",\"item\":\"https://docs.quiva.ai/api-reference/templates/get-template\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Templates\",\"item\":\"https://docs.quiva.ai/api-reference/templates/get-template\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create template\",\"item\":\"https://docs.quiva.ai/api-reference/templates/create-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.quiva.ai/api-reference/templates/create-template#apireference\",\"headline\":\"Create template\",\"name\":\"Create template\",\"description\":\"Create a new draft template. Returns 402 if a template with the same key already exists (use PATCH /templates/{key} to update an existing draft). The source object references a DOCX file already uploaded to microstrate-documents object storage bucket. That file is processed by replacing tags with data from payload when the template is triggered: tags inside the DOCX (e.g. {client_name}, {#line_items}…{/line_items}, {subtotal + tax}) are evaluated against the trigger payload to produce the final output — a PDF when output.content_type is application/pdf, or a rendered DOCX. Other expression-aware fields: - output.name — output filename template, e.g. invoice-{invoice_number}; the extension (.pdf/.docx) is appended automatically based on output.content_type. - signatories[].name / signatories[].email — resolved against the payload before the Signature request is sent. Signatories whose rendered email is missing or invalid are skipped. - sub_templates[].conditions — rule-engine conditions evaluated against the payload; matching sub-templates are rendered and merged after the main template. It is recommended to run POST /templates/validate on the DOCX content first to catch malformed tags.\",\"url\":\"https://docs.quiva.ai/api-reference/templates/create-template\",\"mainEntityOfPage\":{\"@id\":\"https://docs.quiva.ai/api-reference/templates/create-template#webpage\"},\"dateModified\":\"2026-11-21T13:49:23.381Z\",\"publisher\":{\"@id\":\"https://docs.quiva.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.quiva.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"QuivaWorks Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"QuivaWorks Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/templates/create-template.md","siteName":"QuivaWorks Docs","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://quiva.ai/community"},{"anchor":"Support","icon":"headset","href":"https://quiva.ai/help-center/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/get-started/overview"}]},{"tab":"Abbie","pages":[{"title":"Abbie","href":"/abbie/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Accounts","pages":[{"group":"Authentication","pages":[{"title":"Initiate OAuth login flow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/oauth/login","href":"/api-reference/authentication/initiate-oauth-login-flow"},{"title":"OAuth callback handler","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/oauth/callback","href":"/api-reference/authentication/oauth-callback-handler"},{"title":"Authenticate with password","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-password","href":"/api-reference/authentication/authenticate-with-password"},{"title":"Authenticate with recovery code","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-recovery-code","href":"/api-reference/authentication/authenticate-with-recovery-code"},{"title":"Request password reset","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/request-reset-password","href":"/api-reference/authentication/request-password-reset"},{"title":"Reset password","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/reset-password","href":"/api-reference/authentication/reset-password"},{"title":"Set password","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/set-password","href":"/api-reference/authentication/set-password"},{"title":"Authenticate with TOTP","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-totp","href":"/api-reference/authentication/authenticate-with-totp"},{"title":"Get email verification code","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/email-code","href":"/api-reference/authentication/get-email-verification-code"},{"title":"Begin passkey authentication","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/begin-auth-with-passkey","href":"/api-reference/authentication/begin-passkey-authentication"},{"title":"Validate token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/token-validate","href":"/api-reference/authentication/validate-token"},{"title":"Authenticate with API key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-api-key","href":"/api-reference/authentication/authenticate-with-api-key"},{"title":"Get session tokens","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/session-tokens","href":"/api-reference/authentication/get-session-tokens"},{"title":"Revoke auth token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/auth-token","href":"/api-reference/authentication/revoke-auth-token"},{"title":"Refresh authentication token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/refresh-token","href":"/api-reference/authentication/refresh-authentication-token"},{"title":"Revoke refresh token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/refresh-token","href":"/api-reference/authentication/revoke-refresh-token"},{"title":"Revoke all tokens","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/tokens","href":"/api-reference/authentication/revoke-all-tokens"},{"title":"Complete passkey authentication","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/complete-auth-with-passkey","href":"/api-reference/authentication/complete-passkey-authentication"},{"title":"Mint an integration token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /oauth/token","href":"/api-reference/authentication/mint-an-integration-token"},{"title":"Finish sign-in on the chosen account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-select-account","href":"/api-reference/authentication/finish-sign-in-on-the-chosen-account"},{"title":"Email a client a sign-in link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/send-client-sign-in","href":"/api-reference/authentication/email-a-client-a-sign-in-link"}]},{"group":"Account Management","pages":[{"title":"Get account information","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/info","href":"/api-reference/account-management/get-account-information"},{"title":"Set emergency credit","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/set-emergency-credit","href":"/api-reference/account-management/set-emergency-credit"},{"title":"Rename account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/rename","href":"/api-reference/account-management/rename-account"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts","href":"/api-reference/account-management/create-account"},{"title":"Update account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts","href":"/api-reference/account-management/update-account"},{"title":"Delete account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/account","href":"/api-reference/account-management/delete-account"},{"title":"Cancel account deletion","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/cancel-account-deletion","href":"/api-reference/account-management/cancel-account-deletion"},{"title":"Add import","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/import","href":"/api-reference/account-management/add-import"},{"title":"Remove import","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/import","href":"/api-reference/account-management/remove-import"},{"title":"Add export","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/export","href":"/api-reference/account-management/add-export"},{"title":"Remove export","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/export","href":"/api-reference/account-management/remove-export"},{"title":"List accounts by user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/list","href":"/api-reference/account-management/list-accounts-by-user"},{"title":"Confirm email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/confirm-email","href":"/api-reference/account-management/confirm-email"},{"title":"Resend email confirmation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/resend-confirmation","href":"/api-reference/account-management/resend-email-confirmation"},{"title":"Submit contact form","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/submit-contact-form","href":"/api-reference/account-management/submit-contact-form"},{"title":"Change the sign-in address (slug)","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/slug","href":"/api-reference/account-management/change-the-sign-in-address-slug"},{"title":"List vertical template updates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/vertical-updates","href":"/api-reference/account-management/list-vertical-template-updates"},{"title":"Mint an export activation token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/export-activation","href":"/api-reference/account-management/mint-an-export-activation-token"}]},{"group":"API Keys","pages":[{"title":"Issue API key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/api-key","href":"/api-reference/api-keys/issue-api-key"},{"title":"Delete API key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/api-key","href":"/api-reference/api-keys/delete-api-key"},{"title":"View API keys","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/api-keys","href":"/api-reference/api-keys/view-api-keys"},{"title":"Get API credentials","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/api-creds","href":"/api-reference/api-keys/get-api-credentials"}]},{"group":"User Management","pages":[{"title":"Upload profile image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/profile-image","href":"/api-reference/user-management/upload-profile-image"},{"title":"Delete profile image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/profile-image","href":"/api-reference/user-management/delete-profile-image"},{"title":"Remove user from account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/remove-user","href":"/api-reference/user-management/remove-user-from-account"},{"title":"Create/Add user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/users","href":"/api-reference/user-management/createadd-user"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/user","href":"/api-reference/user-management/delete-user"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/user","href":"/api-reference/user-management/update-user"},{"title":"Request email address change","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/request-email-address-change","href":"/api-reference/user-management/request-email-address-change"},{"title":"Complete email address change","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/change-email-address-action","href":"/api-reference/user-management/complete-email-address-change"},{"title":"List users by account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/users/list","href":"/api-reference/user-management/list-users-by-account"},{"title":"Update user role","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/role","href":"/api-reference/user-management/update-user-role"},{"title":"Suspend user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/suspend-user","href":"/api-reference/user-management/suspend-user"},{"title":"Get user login data","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/user-login-data","href":"/api-reference/user-management/get-user-login-data"}]},{"group":"Multi-Factor Authentication","pages":[{"title":"View recovery codes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/recovery-codes","href":"/api-reference/multi-factor-authentication/view-recovery-codes"},{"title":"Issue recovery codes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/recovery-codes","href":"/api-reference/multi-factor-authentication/issue-recovery-codes"},{"title":"Generate TOTP key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/generate-totp-key","href":"/api-reference/multi-factor-authentication/generate-totp-key"},{"title":"Confirm TOTP registration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/confirm-totp-registration","href":"/api-reference/multi-factor-authentication/confirm-totp-registration"},{"title":"Remove TOTP","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/totp","href":"/api-reference/multi-factor-authentication/remove-totp"},{"title":"Begin passkey registration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/begin-passkey-registration","href":"/api-reference/multi-factor-authentication/begin-passkey-registration"},{"title":"Complete passkey registration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/complete-passkey-registration","href":"/api-reference/multi-factor-authentication/complete-passkey-registration"},{"title":"Remove passkey","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/passkey","href":"/api-reference/multi-factor-authentication/remove-passkey"},{"title":"Get user MFA info","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/user-mfa-info","href":"/api-reference/multi-factor-authentication/get-user-mfa-info"},{"title":"Update MFA settings","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/mfa-settings","href":"/api-reference/multi-factor-authentication/update-mfa-settings"},{"title":"Remove all passkeys","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/all-passkeys","href":"/api-reference/multi-factor-authentication/remove-all-passkeys"}]},{"group":"Mesh Nodes","pages":[{"title":"Update mesh nodes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json put /accounts/mesh-nodes","href":"/api-reference/mesh-nodes/update-mesh-nodes"}]},{"group":"Payment","pages":[{"title":"Process payment webhook","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/webhook","href":"/api-reference/payment/process-payment-webhook"},{"title":"Get products","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/products","href":"/api-reference/payment/get-products"},{"title":"Get prices","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/prices","href":"/api-reference/payment/get-prices"},{"title":"Get checkout URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/checkout-url","href":"/api-reference/payment/get-checkout-url"},{"title":"Get dashboard URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/dashboard-url","href":"/api-reference/payment/get-dashboard-url"},{"title":"Get subscription items","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/subscription-items","href":"/api-reference/payment/get-subscription-items"},{"title":"Get subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/subscription","href":"/api-reference/payment/get-subscription"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/payment/subscription","href":"/api-reference/payment/cancel-subscription"},{"title":"Update subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/payment/subscription","href":"/api-reference/payment/update-subscription"},{"title":"Create free subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/free-subscription","href":"/api-reference/payment/create-free-subscription"},{"title":"List credit packs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/credit-packs","href":"/api-reference/payment/list-credit-packs"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/payment-methods","href":"/api-reference/payment/list-payment-methods"},{"title":"Buy a credit pack","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/ai-budget","href":"/api-reference/payment/buy-a-credit-pack"},{"title":"Cancel a scheduled downgrade","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/payment/subscription-schedule","href":"/api-reference/payment/cancel-a-scheduled-downgrade"}]},{"group":"Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"Create an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Read an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations/{id}","href":"/api-reference/integrations/read-an-integration"},{"title":"Delete an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/integrations/{id}","href":"/api-reference/integrations/delete-an-integration"},{"title":"Update or disable an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/integrations/{id}","href":"/api-reference/integrations/update-or-disable-an-integration"},{"title":"Rotate the client secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations/{id}/secrets","href":"/api-reference/integrations/rotate-the-client-secret"},{"title":"Revoke a client secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/integrations/{id}/secrets/{secret_id}","href":"/api-reference/integrations/revoke-a-client-secret"}]},{"group":"Task Subscriptions","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations/{id}/subscriptions","href":"/api-reference/task-subscriptions/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations/{id}/subscriptions","href":"/api-reference/task-subscriptions/create-a-webhook-subscription"},{"title":"Delete a subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/integrations/{id}/subscriptions/{sid}","href":"/api-reference/task-subscriptions/delete-a-subscription"},{"title":"Update, resume or rotate a subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/integrations/{id}/subscriptions/{sid}","href":"/api-reference/task-subscriptions/update-resume-or-rotate-a-subscription"},{"title":"Replay events or send a test event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations/{id}/subscriptions/{sid}/replay","href":"/api-reference/task-subscriptions/replay-events-or-send-a-test-event"},{"title":"Read the delivery log","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations/{id}/subscriptions/{sid}/deliveries","href":"/api-reference/task-subscriptions/read-the-delivery-log"}]},{"group":"Branding","pages":[{"title":"Get sign-in branding","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/client-branding","href":"/api-reference/branding/get-sign-in-branding"},{"title":"Upload the dark-mode favicon","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/favicon-dark","href":"/api-reference/branding/upload-the-dark-mode-favicon"},{"title":"Remove the dark-mode favicon","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/favicon-dark","href":"/api-reference/branding/remove-the-dark-mode-favicon"},{"title":"Publish a record image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/record-image","href":"/api-reference/branding/publish-a-record-image"},{"title":"Delete a record image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/record-image","href":"/api-reference/branding/delete-a-record-image"},{"title":"Get an icon font access token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /fontawesome/token","href":"/api-reference/branding/get-an-icon-font-access-token"}]},{"group":"Email Templates","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/email-templates","href":"/api-reference/email-templates/list-email-templates"},{"title":"Get an email template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/email-template","href":"/api-reference/email-templates/get-an-email-template"},{"title":"Create a template or replace its draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template","href":"/api-reference/email-templates/create-a-template-or-replace-its-draft"},{"title":"Delete an email template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/email-template","href":"/api-reference/email-templates/delete-an-email-template"},{"title":"Publish the draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-publish","href":"/api-reference/email-templates/publish-the-draft"},{"title":"Discard the draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-discard","href":"/api-reference/email-templates/discard-the-draft"},{"title":"Render a template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-render","href":"/api-reference/email-templates/render-a-template"},{"title":"Attach a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-attachment","href":"/api-reference/email-templates/attach-a-file"},{"title":"Remove an attachment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-attachment-remove","href":"/api-reference/email-templates/remove-an-attachment"}]},{"group":"Client Access","pages":[{"title":"Request a client sign-in link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/request-client-magic-link","href":"/api-reference/client-access/request-a-client-sign-in-link"},{"title":"Sign in with a magic link or code","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-magic-link","href":"/api-reference/client-access/sign-in-with-a-magic-link-or-code"},{"title":"Send a client invitation email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/send-client-invite","href":"/api-reference/client-access/send-a-client-invitation-email"},{"title":"Clear a client sign-in lock","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/clear-client-signin-lock","href":"/api-reference/client-access/clear-a-client-sign-in-lock"}]},{"group":"Document Branding","pages":[{"title":"Get the document theme","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/document-theme","href":"/api-reference/document-branding/get-the-document-theme"},{"title":"Set the document logo","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/document-logo","href":"/api-reference/document-branding/set-the-document-logo"},{"title":"Remove the document logo","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/document-logo","href":"/api-reference/document-branding/remove-the-document-logo"}]},{"group":"Resource Access","pages":[{"title":"Assign resources to a user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/assign-resources","href":"/api-reference/resource-access/assign-resources-to-a-user"},{"title":"Remove resource assignments from a user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/unassign-resources","href":"/api-reference/resource-access/remove-resource-assignments-from-a-user"},{"title":"List resources assigned to a user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/assigned-resources","href":"/api-reference/resource-access/list-resources-assigned-to-a-user"}]},{"group":"Sync Packages","pages":[{"title":"List sync packages","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/sync-packages","href":"/api-reference/sync-packages/list-sync-packages"},{"title":"List sync package installs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/sync-packages/installs","href":"/api-reference/sync-packages/list-sync-package-installs"},{"title":"Install a sync package","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sync-packages/install","href":"/api-reference/sync-packages/install-a-sync-package"},{"title":"Upgrade a sync package install","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sync-packages/upgrade","href":"/api-reference/sync-packages/upgrade-a-sync-package-install"},{"title":"Uninstall a sync package","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sync-packages/uninstall","href":"/api-reference/sync-packages/uninstall-a-sync-package"}]},{"group":"Terms","pages":[{"title":"List terms documents","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/documents","href":"/api-reference/terms/list-terms-documents"},{"title":"Update a terms document draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json put /accounts/terms/document","href":"/api-reference/terms/update-a-terms-document-draft"},{"title":"Create a terms document draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/document","href":"/api-reference/terms/create-a-terms-document-draft"},{"title":"Archive a terms document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/terms/document","href":"/api-reference/terms/archive-a-terms-document"},{"title":"Publish a terms document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/document/publish","href":"/api-reference/terms/publish-a-terms-document"},{"title":"List terms document versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/document/versions","href":"/api-reference/terms/list-terms-document-versions"},{"title":"Get a terms version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/version","href":"/api-reference/terms/get-a-terms-version"},{"title":"Enable or disable a provider","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json put /accounts/terms/provider","href":"/api-reference/terms/enable-or-disable-a-provider"},{"title":"Get provider terms status","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/provider-status","href":"/api-reference/terms/get-provider-terms-status"},{"title":"List terms the caller must accept","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/pending","href":"/api-reference/terms/list-terms-the-caller-must-accept"},{"title":"Accept terms","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/accept","href":"/api-reference/terms/accept-terms"},{"title":"Preview terms for a sign-in link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/pending-for-signin","href":"/api-reference/terms/preview-terms-for-a-sign-in-link"},{"title":"Export the acceptance log","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/acceptances","href":"/api-reference/terms/export-the-acceptance-log"}]},{"group":"Email Sending","pages":[{"title":"Get the sending identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/sender-identity","href":"/api-reference/email-sending/get-the-sending-identity"},{"title":"Set the sending identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sender-identity","href":"/api-reference/email-sending/set-the-sending-identity"},{"title":"Verify the sending identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sender-identity-verify","href":"/api-reference/email-sending/verify-the-sending-identity"},{"title":"Send an email from the account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/send-commercial-email","href":"/api-reference/email-sending/send-an-email-from-the-account"}]},{"group":"Usage and Billing","pages":[{"title":"List cost events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/cost-events","href":"/api-reference/usage-and-billing/list-cost-events"},{"title":"List billing events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/billing-events","href":"/api-reference/usage-and-billing/list-billing-events"},{"title":"Email a cost events export","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/admin/export-cost-events","href":"/api-reference/usage-and-billing/email-a-cost-events-export"},{"title":"Get budget limits and spend guard","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/ai-budget-limits","href":"/api-reference/usage-and-billing/get-budget-limits-and-spend-guard"},{"title":"Set the spend guard","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/ai-budget-limits","href":"/api-reference/usage-and-billing/set-the-spend-guard"},{"title":"Override the spend guard","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/ai-budget-limits/override","href":"/api-reference/usage-and-billing/override-the-spend-guard"},{"title":"Get the credit balance","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/ai-budget","href":"/api-reference/usage-and-billing/get-the-credit-balance"},{"title":"Get a usage summary","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/usage-summary","href":"/api-reference/usage-and-billing/get-a-usage-summary"},{"title":"Set auto top-up","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/auto-topup","href":"/api-reference/usage-and-billing/set-auto-top-up"},{"title":"Set the credit warning level","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/credit-warning","href":"/api-reference/usage-and-billing/set-the-credit-warning-level"}]},{"group":"Notifications","pages":[{"title":"List notifications","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/users/notifications","href":"/api-reference/notifications/list-notifications"},{"title":"Mark a notification viewed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/users/notifications/viewed","href":"/api-reference/notifications/mark-a-notification-viewed"},{"title":"Mark notifications viewed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/users/notifications/viewed-all","href":"/api-reference/notifications/mark-notifications-viewed"}]}]},{"group":"Task sync","pages":[{"title":"Task sync authentication","icon":"key","href":"/api-reference/task-sync-auth"},{"title":"Task sync errors and limits","icon":"triangle-exclamation","href":"/api-reference/task-sync-errors"}]},{"group":"Workspaces","pages":[{"group":"Spaces","pages":[{"title":"List all spaces","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/spaces","href":"/api-reference/spaces/list-all-spaces"},{"title":"Create a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space","href":"/api-reference/spaces/create-a-space"},{"title":"Get a space by ID","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{id}","href":"/api-reference/spaces/get-a-space-by-id"},{"title":"Delete a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/space/{id}","href":"/api-reference/spaces/delete-a-space"},{"title":"Update a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/space/{id}","href":"/api-reference/spaces/update-a-space"},{"title":"List tasks in a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{space_id}/tasks","href":"/api-reference/spaces/list-tasks-in-a-space"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task","href":"/api-reference/spaces/create-a-task"},{"title":"Update multiple tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/tasks","href":"/api-reference/spaces/update-multiple-tasks"},{"title":"Get a task by ID","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{id}","href":"/api-reference/spaces/get-a-task-by-id"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{id}","href":"/api-reference/spaces/delete-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/task/{id}","href":"/api-reference/spaces/update-a-task"},{"title":"Create a comment on a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/comment","href":"/api-reference/spaces/create-a-comment-on-a-task"},{"title":"List comments on a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/comments","href":"/api-reference/spaces/list-comments-on-a-task"},{"title":"Add or remove a reaction on a comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/comment/{id}/reaction","href":"/api-reference/spaces/add-or-remove-a-reaction-on-a-comment"},{"title":"Get a comment by ID","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/comment/{id}","href":"/api-reference/spaces/get-a-comment-by-id"},{"title":"Delete a comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/comment/{id}","href":"/api-reference/spaces/delete-a-comment"},{"title":"Update a comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/task/{task_id}/comment/{id}","href":"/api-reference/spaces/update-a-comment"},{"title":"List a task's time logs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/time-log","href":"/api-reference/spaces/list-a-tasks-time-logs"},{"title":"Log time against a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task/{task_id}/time-log","href":"/api-reference/spaces/log-time-against-a-task"},{"title":"List task templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task-templates","href":"/api-reference/spaces/list-task-templates"},{"title":"Create a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task-template","href":"/api-reference/spaces/create-a-task-template"},{"title":"Get a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task-template/{id}","href":"/api-reference/spaces/get-a-task-template"},{"title":"Delete a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task-template/{id}","href":"/api-reference/spaces/delete-a-task-template"},{"title":"Update a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/task-template/{id}","href":"/api-reference/spaces/update-a-task-template"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/client","href":"/api-reference/spaces/create-a-contact"},{"title":"List meeting files in a Space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/meetings","href":"/api-reference/spaces/list-meeting-files-in-a-space"}]},{"group":"Tasks","pages":[{"title":"Delete every task in a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/tasks","href":"/api-reference/tasks/delete-every-task-in-a-folder"},{"title":"Create or update a task by external id","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/space/{space_id}/tasks/external/{external_id}","href":"/api-reference/tasks/create-or-update-a-task-by-external-id"},{"title":"Create a task from a template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task-from-template","href":"/api-reference/tasks/create-a-task-from-a-template"},{"title":"Watch a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/watch","href":"/api-reference/tasks/watch-a-task"},{"title":"Stop watching a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/watch","href":"/api-reference/tasks/stop-watching-a-task"},{"title":"Mute a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/mute","href":"/api-reference/tasks/mute-a-task"},{"title":"Unmute a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/mute","href":"/api-reference/tasks/unmute-a-task"},{"title":"List my tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/tasks/my-tasks","href":"/api-reference/tasks/list-my-tasks"},{"title":"List a client's tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/client/tasks","href":"/api-reference/tasks/list-a-clients-tasks"},{"title":"Get a task's change log","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/change-log","href":"/api-reference/tasks/get-a-tasks-change-log"},{"title":"Export a space's tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{space_id}/export-tasks","href":"/api-reference/tasks/export-a-spaces-tasks"}]},{"group":"Task Actions","pages":[{"title":"List task checklist actions — currently unavailable","deprecated":true,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/action","href":"/api-reference/task-actions/list-task-checklist-actions-—-currently-unavailable"},{"title":"Create or update a task checklist action","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task/{task_id}/action","href":"/api-reference/task-actions/create-or-update-a-task-checklist-action"},{"title":"Delete a task checklist action","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/action/{id}","href":"/api-reference/task-actions/delete-a-task-checklist-action"}]},{"group":"Changes","pages":[{"title":"Read the changes feed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{space_id}/changes","href":"/api-reference/changes/read-the-changes-feed"}]},{"group":"Sandbox","pages":[{"title":"Copy a space's structure","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space/{space_id}/copy-structure","href":"/api-reference/sandbox/copy-a-spaces-structure"},{"title":"Reset a staging space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space/{space_id}/reset","href":"/api-reference/sandbox/reset-a-staging-space"}]},{"group":"Entity Comments","pages":[{"title":"List entity comments","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/entity/{entity_type}/{entity_id}/comments","href":"/api-reference/entity-comments/list-entity-comments"},{"title":"Create an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/entity/{entity_type}/{entity_id}/comment","href":"/api-reference/entity-comments/create-an-entity-comment"},{"title":"Get an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/entity/{entity_type}/{entity_id}/comment/{id}","href":"/api-reference/entity-comments/get-an-entity-comment"},{"title":"Delete an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/entity/{entity_type}/{entity_id}/comment/{id}","href":"/api-reference/entity-comments/delete-an-entity-comment"},{"title":"Update an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/entity/{entity_type}/{entity_id}/comment/{id}","href":"/api-reference/entity-comments/update-an-entity-comment"},{"title":"Add or remove a reaction on an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/entity/{entity_type}/{entity_id}/comment/{id}/reaction","href":"/api-reference/entity-comments/add-or-remove-a-reaction-on-an-entity-comment"},{"title":"Download an entity comment attachment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/entity/{entity_type}/{entity_id}/comment/{id}/attachment","href":"/api-reference/entity-comments/download-an-entity-comment-attachment"}]},{"group":"Task Relations","pages":[{"title":"List related tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/relations","href":"/api-reference/task-relations/list-related-tasks"},{"title":"Link two tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task-relation","href":"/api-reference/task-relations/link-two-tasks"},{"title":"Unlink two tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/relation/{related_task_id}","href":"/api-reference/task-relations/unlink-two-tasks"}]},{"group":"Space Collections","pages":[{"title":"List space collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space-collections","href":"/api-reference/space-collections/list-space-collections"},{"title":"Create a space collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space-collection","href":"/api-reference/space-collections/create-a-space-collection"},{"title":"Delete a space collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/space-collection/{id}","href":"/api-reference/space-collections/delete-a-space-collection"},{"title":"Update a space collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/space-collection/{id}","href":"/api-reference/space-collections/update-a-space-collection"},{"title":"Reorder space collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/space-collections-order","href":"/api-reference/space-collections/reorder-space-collections"}]},{"group":"Folders","pages":[{"title":"Rename a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/folder-name","href":"/api-reference/folders/rename-a-folder"},{"title":"Resolve a folder display path","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/resolve-folder","href":"/api-reference/folders/resolve-a-folder-display-path"},{"title":"File a case under its client folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/case-folder","href":"/api-reference/folders/file-a-case-under-its-client-folder"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/files/folder","href":"/api-reference/folders/create-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/files/folder","href":"/api-reference/folders/delete-a-folder"}]},{"group":"Task Schedules","pages":[{"title":"List a task's scheduled events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/scheduled-events","href":"/api-reference/task-schedules/list-a-tasks-scheduled-events"},{"title":"Schedule a task event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/scheduled-events","href":"/api-reference/task-schedules/schedule-a-task-event"},{"title":"List scheduled events in a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/scheduled-events","href":"/api-reference/task-schedules/list-scheduled-events-in-a-space"},{"title":"Update a scheduled task event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task/{task_id}/scheduled-events/{id}","href":"/api-reference/task-schedules/update-a-scheduled-task-event"},{"title":"Cancel a scheduled task event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/scheduled-events/{id}","href":"/api-reference/task-schedules/cancel-a-scheduled-task-event"},{"title":"Mark a task event notification read","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/scheduled-events/{id}/read","href":"/api-reference/task-schedules/mark-a-task-event-notification-read"}]},{"group":"Files","pages":[{"title":"List a space's files","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files","href":"/api-reference/files/list-a-spaces-files"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/files","href":"/api-reference/files/delete-a-file"},{"title":"List trashed files","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files/trash","href":"/api-reference/files/list-trashed-files"},{"title":"Restore from trash","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/files/restore","href":"/api-reference/files/restore-from-trash"},{"title":"Update a file's metadata","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/file/{name}/metadata","href":"/api-reference/files/update-a-files-metadata"},{"title":"List a file's versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files/versions","href":"/api-reference/files/list-a-files-versions"},{"title":"Get one file version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files/version","href":"/api-reference/files/get-one-file-version"},{"title":"Restore a file version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/files/version/restore","href":"/api-reference/files/restore-a-file-version"},{"title":"Save a chat-session file to a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/save-session-file","href":"/api-reference/files/save-a-chat-session-file-to-a-space"}]},{"group":"Distribution","pages":[{"title":"Bind a distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/distribution-binding","href":"/api-reference/distribution/bind-a-distribution"},{"title":"Remove a distribution binding","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/distribution-binding","href":"/api-reference/distribution/remove-a-distribution-binding"}]}]},{"group":"Records","pages":[{"group":"Record Configs","pages":[{"title":"List record configurations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config","href":"/api-reference/record-configs/list-record-configurations"},{"title":"Create a record configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config","href":"/api-reference/record-configs/create-a-record-configuration"},{"title":"Get a record configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config/{id}","href":"/api-reference/record-configs/get-a-record-configuration"},{"title":"Update a record configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json put /records/config/{id}","href":"/api-reference/record-configs/update-a-record-configuration"},{"title":"Delete a record configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/config/{id}","href":"/api-reference/record-configs/delete-a-record-configuration"},{"title":"List shipped fields a config can adopt","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config/upgrades","href":"/api-reference/record-configs/list-shipped-fields-a-config-can-adopt"},{"title":"Adopt shipped fields into a config","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config/upgrade","href":"/api-reference/record-configs/adopt-shipped-fields-into-a-config"}]},{"group":"Record History","pages":[{"title":"Erase a deleted record set's history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/config/{config_id}/history","href":"/api-reference/record-history/erase-a-deleted-record-sets-history"},{"title":"Get a record's change history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/{config_id}/{id}/history","href":"/api-reference/record-history/get-a-records-change-history"},{"title":"Erase a record's history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/{id}/history","href":"/api-reference/record-history/erase-a-records-history"},{"title":"Correct a past version's stored values","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/amend","href":"/api-reference/record-history/correct-a-past-versions-stored-values"},{"title":"Hide a past version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/hide","href":"/api-reference/record-history/hide-a-past-version"},{"title":"Permanently erase a past version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/erase","href":"/api-reference/record-history/permanently-erase-a-past-version"},{"title":"Restore a past version as the record's next version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/restore","href":"/api-reference/record-history/restore-a-past-version-as-the-records-next-version"},{"title":"Read a time-series field across a config's records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/{config_id}/series","href":"/api-reference/record-history/read-a-time-series-field-across-a-configs-records"}]},{"group":"Records","pages":[{"title":"Query records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records","href":"/api-reference/records/query-records"},{"title":"Create a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}","href":"/api-reference/records/create-a-record"},{"title":"Get a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/{config_id}/{id}","href":"/api-reference/records/get-a-record"},{"title":"Update a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json put /records/{config_id}/{id}","href":"/api-reference/records/update-a-record"},{"title":"Delete a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/{id}","href":"/api-reference/records/delete-a-record"},{"title":"Import records from a CSV","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/csv-import","href":"/api-reference/records/import-records-from-a-csv"},{"title":"Delete records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/bulk","href":"/api-reference/records/delete-records"},{"title":"Purge records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/purge","href":"/api-reference/records/purge-records"},{"title":"Create a record once","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/record-once","href":"/api-reference/records/create-a-record-once"},{"title":"Get or make a member's row","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/member-rows","href":"/api-reference/records/get-or-make-a-members-row"},{"title":"Send a members step to every member","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/member-send","href":"/api-reference/records/send-a-members-step-to-every-member"},{"title":"Read a members step send","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/member-send/{id}","href":"/api-reference/records/read-a-members-step-send"},{"title":"Upsert a record by identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/upsert-record","href":"/api-reference/records/upsert-a-record-by-identity"},{"title":"Delete a record while a field is unset","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/record-if","href":"/api-reference/records/delete-a-record-while-a-field-is-unset"},{"title":"Reindex a config's records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/reindex","href":"/api-reference/records/reindex-a-configs-records"},{"title":"Export a record set as a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/export-records","href":"/api-reference/records/export-a-record-set-as-a-file"},{"title":"Count records per config","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/records-count-by-config","href":"/api-reference/records/count-records-per-config"}]},{"group":"Record Config Collections","pages":[{"title":"List record config collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-collections","href":"/api-reference/record-config-collections/list-record-config-collections"},{"title":"Create a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config-collections","href":"/api-reference/record-config-collections/create-a-record-config-collection"},{"title":"Get a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-collections/{id}","href":"/api-reference/record-config-collections/get-a-record-config-collection"},{"title":"Update a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json put /records/config-collections/{id}","href":"/api-reference/record-config-collections/update-a-record-config-collection"},{"title":"Delete a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/config-collections/{id}","href":"/api-reference/record-config-collections/delete-a-record-config-collection"}]},{"group":"Record Config Versions","pages":[{"title":"List a record configuration's published versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-versions/{id}","href":"/api-reference/record-config-versions/list-a-record-configurations-published-versions"},{"title":"Get one published version with its snapshot","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-version/{id}","href":"/api-reference/record-config-versions/get-one-published-version-with-its-snapshot"},{"title":"Publish the stored configuration as a new version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config-publish/{id}","href":"/api-reference/record-config-versions/publish-the-stored-configuration-as-a-new-version"}]},{"group":"Record Metrics","pages":[{"title":"Run metrics","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/metrics-run","href":"/api-reference/record-metrics/run-metrics"},{"title":"Validate metric definitions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/metrics-validate","href":"/api-reference/record-metrics/validate-metric-definitions"}]},{"group":"Record Assessment","pages":[{"title":"Interpret a scored record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/interpret","href":"/api-reference/record-assessment/interpret-a-scored-record"},{"title":"Re-run interpretation for a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/reinterpret","href":"/api-reference/record-assessment/re-run-interpretation-for-a-record"},{"title":"Re-extract a record's stored report","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/re-extract","href":"/api-reference/record-assessment/re-extract-a-records-stored-report"},{"title":"Publish the assessment policy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-publish","href":"/api-reference/record-assessment/publish-the-assessment-policy"},{"title":"List policy profiles","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-profiles","href":"/api-reference/record-assessment/list-policy-profiles"},{"title":"Preview a policy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-preview","href":"/api-reference/record-assessment/preview-a-policy"},{"title":"Measure a policy's impact","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-impact","href":"/api-reference/record-assessment/measure-a-policys-impact"},{"title":"Run the assessment setup test","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/setup-test","href":"/api-reference/record-assessment/run-the-assessment-setup-test"},{"title":"Approve discussion notes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/approve-notes","href":"/api-reference/record-assessment/approve-discussion-notes"},{"title":"Agree a score","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/agree-score","href":"/api-reference/record-assessment/agree-a-score"},{"title":"Approve a client report","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/approve-client-report","href":"/api-reference/record-assessment/approve-a-client-report"},{"title":"Render a client report","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/client-report-render","href":"/api-reference/record-assessment/render-a-client-report"},{"title":"Create a discussion note","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/discussion-note","href":"/api-reference/record-assessment/create-a-discussion-note"},{"title":"Mark a discussion note signed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/mark-signed","href":"/api-reference/record-assessment/mark-a-discussion-note-signed"},{"title":"Get approval status","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/approval-status","href":"/api-reference/record-assessment/get-approval-status"},{"title":"Get assessment setup status","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/assess-setup-status","href":"/api-reference/record-assessment/get-assessment-setup-status"},{"title":"Get assessment health","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/assess-health","href":"/api-reference/record-assessment/get-assessment-health"}]},{"group":"Strategy and Simulation","pages":[{"title":"Publish a strategy version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/strategy-publish","href":"/api-reference/strategy-and-simulation/publish-a-strategy-version"},{"title":"Get a strategy version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/strategy-version","href":"/api-reference/strategy-and-simulation/get-a-strategy-version"},{"title":"List strategy versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/strategy-versions","href":"/api-reference/strategy-and-simulation/list-strategy-versions"},{"title":"Get a strategy method text","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/strategy-method","href":"/api-reference/strategy-and-simulation/get-a-strategy-method-text"},{"title":"Run a simulation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-run","href":"/api-reference/strategy-and-simulation/run-a-simulation"},{"title":"Compare simulation variants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-compare","href":"/api-reference/strategy-and-simulation/compare-simulation-variants"},{"title":"Solve for a simulation target","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-solve","href":"/api-reference/strategy-and-simulation/solve-for-a-simulation-target"},{"title":"Save a simulation result","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-save","href":"/api-reference/strategy-and-simulation/save-a-simulation-result"}]}]},{"group":"Documents","pages":[{"group":"Templates","pages":[{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/templates/{key}","href":"/api-reference/templates/get-template"},{"title":"Delete template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json delete /file-generator/templates/{key}","href":"/api-reference/templates/delete-template"},{"title":"Update template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /file-generator/templates/{key}","href":"/api-reference/templates/update-template"},{"title":"List templates","description":"List all templates. Pass `?draft=true` to list draft templates instead of published ones.\n\nThe response is paged stream-style: `results_total` is the number of items in this response, `total_messages` is the total available, and `next_sequence` is the cursor for the next page.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/templates","href":"/api-reference/templates/list-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates","href":"/api-reference/templates/create-template"},{"title":"Publish template","description":"Promote a draft template to published state. The published version is what `POST /templates/trigger` uses to generate documents — draft edits have no effect on generation until published.\n\nPublishing copies the current draft aggregate to the published record; subsequent draft edits do not leak into the published version. Returns `400` if no draft exists for the key.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/{key}/publish","href":"/api-reference/templates/publish-template"},{"title":"Validate template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/validate","href":"/api-reference/templates/validate-template"},{"title":"Unset template paths","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/{key}/unset","href":"/api-reference/templates/unset-template-paths"},{"title":"Trigger template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/trigger","href":"/api-reference/templates/trigger-template"}]},{"group":"Documents","pages":[{"title":"Get document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/documents/{key}","href":"/api-reference/documents/get-document"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json delete /file-generator/documents/{key}","href":"/api-reference/documents/delete-document"},{"title":"Update document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /file-generator/documents/{key}","href":"/api-reference/documents/update-document"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/documents","href":"/api-reference/documents/list-documents"},{"title":"Unset document paths","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /file-generator/documents/{key}/unset","href":"/api-reference/documents/unset-document-paths"},{"title":"List files assigned to me","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/assigned-files","href":"/api-reference/documents/list-files-assigned-to-me"},{"title":"Read fonts and colours from an Office file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/brand-extract","href":"/api-reference/documents/read-fonts-and-colours-from-an-office-file"}]},{"group":"Signatures","pages":[{"title":"Get document signature URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/documents/{key}/signature-url","href":"/api-reference/signatures/get-document-signature-url"},{"title":"HelloSign callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/webhooks/hellosign/{account}","href":"/api-reference/signatures/hellosign-callback"}]},{"group":"Approvals","pages":[{"title":"List approvals for a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /workspaces/approvals","href":"/api-reference/approvals/list-approvals-for-a-file"},{"title":"Request an approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /workspaces/approvals","href":"/api-reference/approvals/request-an-approval"},{"title":"Get an approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /workspaces/approvals/{id}","href":"/api-reference/approvals/get-an-approval"},{"title":"Delete an approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json delete /workspaces/approvals/{id}","href":"/api-reference/approvals/delete-an-approval"},{"title":"Approve a document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /workspaces/approvals/{id}/approve","href":"/api-reference/approvals/approve-a-document"},{"title":"Reject a document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /workspaces/approvals/{id}/reject","href":"/api-reference/approvals/reject-a-document"},{"title":"List approval events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /workspaces/approvals/{id}/events","href":"/api-reference/approvals/list-approval-events"},{"title":"Record a signatory event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /workspaces/approvals/{id}/events","href":"/api-reference/approvals/record-a-signatory-event"}]},{"group":"Generation","pages":[{"title":"Generate a PPTX presentation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/pptx","href":"/api-reference/generation/generate-a-pptx-presentation"},{"title":"Convert HTML to PDF","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/html-pdf","href":"/api-reference/generation/convert-html-to-pdf"},{"title":"Generate a DOCX document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-generator","href":"/api-reference/generation/generate-a-docx-document"},{"title":"Edit a DOCX document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-editor","href":"/api-reference/generation/edit-a-docx-document"},{"title":"Generate a PDF with Python","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/pdf-python","href":"/api-reference/generation/generate-a-pdf-with-python"},{"title":"Create or edit an XLSX spreadsheet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/xlsx","href":"/api-reference/generation/create-or-edit-an-xlsx-spreadsheet"},{"title":"Read an XLSX spreadsheet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/xlsx-read","href":"/api-reference/generation/read-an-xlsx-spreadsheet"},{"title":"Convert a document between formats","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/document-convert","href":"/api-reference/generation/convert-a-document-between-formats"}]},{"group":"Template Source","pages":[{"title":"Render-check a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-render-check","href":"/api-reference/template-source/render-check-a-docx-template-source"},{"title":"Lint a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-lint","href":"/api-reference/template-source/lint-a-docx-template-source"},{"title":"Tag a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-tag","href":"/api-reference/template-source/tag-a-docx-template-source"},{"title":"Repair a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-repair","href":"/api-reference/template-source/repair-a-docx-template-source"},{"title":"List DOCX template source versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-source-versions","href":"/api-reference/template-source/list-docx-template-source-versions"},{"title":"Restore a DOCX template source version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-source-restore","href":"/api-reference/template-source/restore-a-docx-template-source-version"},{"title":"Discard DOCX template edits","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-discard-edits","href":"/api-reference/template-source/discard-docx-template-edits"},{"title":"Edit DOCX template wording","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-edit-text","href":"/api-reference/template-source/edit-docx-template-wording"},{"title":"Locate a DOCX template working copy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-working-locate","href":"/api-reference/template-source/locate-a-docx-template-working-copy"},{"title":"Adopt a sandbox candidate as the working copy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-adopt","href":"/api-reference/template-source/adopt-a-sandbox-candidate-as-the-working-copy"},{"title":"Promote a scratch copy to the working copy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-promote-scratch","href":"/api-reference/template-source/promote-a-scratch-copy-to-the-working-copy"}]}]},{"group":"Secrets Manager","pages":[{"group":"Secrets","pages":[{"title":"List secrets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json get /secrets","href":"/api-reference/secrets/list-secrets"},{"title":"Create or update a secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json put /secrets","href":"/api-reference/secrets/create-or-update-a-secret"},{"title":"Get a secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json get /secrets/{key}","href":"/api-reference/secrets/get-a-secret"},{"title":"Delete a secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json delete /secrets/{key}","href":"/api-reference/secrets/delete-a-secret"},{"title":"List personal secrets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json get /secrets/user","href":"/api-reference/secrets/list-personal-secrets"}]}]},{"group":"Hub Flows","pages":[{"group":"Collections","pages":[{"title":"List collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/collections","href":"/api-reference/collections/list-collections"},{"title":"Create a new collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/collections","href":"/api-reference/collections/create-a-new-collection"},{"title":"Get a collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/collections/{collection_type}/{collection_topic}","href":"/api-reference/collections/get-a-collection"},{"title":"Delete a collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/collections/{collection_type}/{collection_topic}","href":"/api-reference/collections/delete-a-collection"},{"title":"Update a Workflow or Node collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/collections/{collection_type}/{collection_topic}","href":"/api-reference/collections/update-a-workflow-or-node-collection"}]},{"group":"Nodes","pages":[{"title":"List node templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/nodes","href":"/api-reference/nodes/list-node-templates"},{"title":"Create a new node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/nodes","href":"/api-reference/nodes/create-a-new-node"},{"title":"Get a node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/nodes/{collection_topic}/{node_topic}","href":"/api-reference/nodes/get-a-node"},{"title":"Delete a node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/nodes/{collection_topic}/{node_topic}","href":"/api-reference/nodes/delete-a-node"},{"title":"Update a node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/nodes/{collection_topic}/{node_topic}","href":"/api-reference/nodes/update-a-node"},{"title":"Update multiple nodes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/nodes/batch","href":"/api-reference/nodes/update-multiple-nodes"},{"title":"Get a node projection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/nodes/{collection_topic}/{node_topic}/projection","href":"/api-reference/nodes/get-a-node-projection"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create a new workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows","href":"/api-reference/workflows/create-a-new-workflow"},{"title":"Get a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}","href":"/api-reference/workflows/get-a-workflow"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/workflows/{collection_topic}/{flow_topic}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/workflows/{collection_topic}/{flow_topic}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Run a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/{collection_topic}/{flow_topic}/run","href":"/api-reference/workflows/run-a-workflow"},{"title":"Workflow Configuration History","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}/history","href":"/api-reference/workflows/workflow-configuration-history"},{"title":"Publish a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/publish","href":"/api-reference/workflows/publish-a-workflow"},{"title":"Get a node of a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}/node/{node_topic}","href":"/api-reference/workflows/get-a-node-of-a-workflow"},{"title":"Check a workflow's node and edge lists","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}/integrity","href":"/api-reference/workflows/check-a-workflows-node-and-edge-lists"},{"title":"Validate a workflow config","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/validate","href":"/api-reference/workflows/validate-a-workflow-config"},{"title":"Run a workflow as a test","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/run-test","href":"/api-reference/workflows/run-a-workflow-as-a-test"},{"title":"Get run statistics","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/run-stats","href":"/api-reference/workflows/get-run-statistics"}]},{"group":"Oauth","pages":[{"title":"List OAuth configurations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-config","href":"/api-reference/oauth/list-oauth-configurations"},{"title":"Get OAuth configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-config","href":"/api-reference/oauth/get-oauth-configuration"},{"title":"Update an OAuth configuration.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json put /hub/integrations/{integration_id}/oauth-config","href":"/api-reference/oauth/update-an-oauth-configuration"},{"title":"Delete an OAuth configuration.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/integrations/{integration_id}/oauth-config","href":"/api-reference/oauth/delete-an-oauth-configuration"},{"title":"List OAuth connections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-connections","href":"/api-reference/oauth/list-oauth-connections"},{"title":"Get OAuth connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-token/{connection_id}","href":"/api-reference/oauth/get-oauth-connection"},{"title":"Get integration connections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-connections","href":"/api-reference/oauth/get-integration-connections"},{"title":"Delete OAuth connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/integrations/{integration_id}/oauth-connections/{connection_id}","href":"/api-reference/oauth/delete-oauth-connection"},{"title":"OAuth callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-callback","href":"/api-reference/oauth/oauth-callback"},{"title":"Refresh OAuth token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-refresh-token/{connection_id}","href":"/api-reference/oauth/refresh-oauth-token"},{"title":"Get OAuth variables","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-variables","href":"/api-reference/oauth/get-oauth-variables"},{"title":"Save OAuth variables","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/integrations/oauth-variables","href":"/api-reference/oauth/save-oauth-variables"}]},{"group":"API Reference","pages":[{"title":"Execute a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/run","href":"/api-reference/execute-a-workflow"},{"title":"List paused workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/paused","href":"/api-reference/list-paused-workflow-runs"},{"title":"List errored workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/errored","href":"/api-reference/list-errored-workflow-runs"},{"title":"Search run logs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/run-logs/search","href":"/api-reference/search-run-logs"},{"title":"List Quiva endpoints","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/quiva-endpoints","href":"/api-reference/list-quiva-endpoints"},{"title":"Test a JSONPath expression","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/test-jpath","href":"/api-reference/test-a-jsonpath-expression"},{"title":"Test an eval-node payload","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/test-eval","href":"/api-reference/test-an-eval-node-payload"},{"title":"Test an http/integration-node request","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/test-http","href":"/api-reference/test-an-httpintegration-node-request"}]},{"group":"Schedules","pages":[{"title":"Schedule a flow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/schedule","href":"/api-reference/schedules/schedule-a-flow"},{"title":"Unschedule a flow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/unschedule/{topic}","href":"/api-reference/schedules/unschedule-a-flow"},{"title":"List scheduled flows","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/scheduled","href":"/api-reference/schedules/list-scheduled-flows"}]},{"group":"Eval snippets","pages":[{"title":"Get an eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/eval-snippet","href":"/api-reference/eval-snippets/get-an-eval-snippet"},{"title":"Delete an eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/eval-snippet","href":"/api-reference/eval-snippets/delete-an-eval-snippet"},{"title":"Store an eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/eval-snippet","href":"/api-reference/eval-snippets/store-an-eval-snippet"},{"title":"Run a stored eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/eval","href":"/api-reference/eval-snippets/run-a-stored-eval-snippet"}]},{"group":"Marketplace","pages":[{"title":"List marketplace flows","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace","href":"/api-reference/marketplace/list-marketplace-flows"},{"title":"Get a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/product","href":"/api-reference/marketplace/get-a-marketplace-product"},{"title":"Get product download statistics","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/product-download-stats","href":"/api-reference/marketplace/get-product-download-statistics"},{"title":"Obtain a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/obtain-marketplace-product","href":"/api-reference/marketplace/obtain-a-marketplace-product"},{"title":"Download a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/marketplace/workflows/download","href":"/api-reference/marketplace/download-a-marketplace-product"},{"title":"Rate a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/marketplace/rate-product","href":"/api-reference/marketplace/rate-a-marketplace-product"},{"title":"List marketplace submissions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/submissions","href":"/api-reference/marketplace/list-marketplace-submissions"},{"title":"Create a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/marketplace/submissions","href":"/api-reference/marketplace/create-a-marketplace-submission"},{"title":"View a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/submissions/{topic}","href":"/api-reference/marketplace/view-a-marketplace-submission"},{"title":"Delete a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/marketplace/submissions/{topic}","href":"/api-reference/marketplace/delete-a-marketplace-submission"},{"title":"Update a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/marketplace/submissions/{topic}","href":"/api-reference/marketplace/update-a-marketplace-submission"}]}]},{"group":"Assistants","pages":[{"group":"Assistants","pages":[{"title":"Cancel assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/cancel","href":"/api-reference/assistants/cancel-assistants"},{"title":"Invoke an AI assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/invoke","href":"/api-reference/assistants/invoke-an-ai-assistant"},{"title":"List assistant templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent","href":"/api-reference/assistants/list-assistant-templates"},{"title":"Create a new assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent","href":"/api-reference/assistants/create-a-new-assistant"},{"title":"Get an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/{id}","href":"/api-reference/assistants/get-an-assistant"},{"title":"Update an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json put /hub/agent/{id}","href":"/api-reference/assistants/update-an-assistant"},{"title":"Delete an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json delete /hub/agent/{id}","href":"/api-reference/assistants/delete-an-assistant"},{"title":"Browse the MCP registry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/mcp/registry","href":"/api-reference/assistants/browse-the-mcp-registry"},{"title":"Register an MCP server to your account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/mcp/register","href":"/api-reference/assistants/register-an-mcp-server-to-your-account"},{"title":"List favorite assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/favorites","href":"/api-reference/assistants/list-favorite-assistants"},{"title":"Favorite an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/favorites/add","href":"/api-reference/assistants/favorite-an-assistant"},{"title":"Unfavorite an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/favorites/remove","href":"/api-reference/assistants/unfavorite-an-assistant"},{"title":"List private assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/list/private","href":"/api-reference/assistants/list-private-assistants"},{"title":"List team assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/list/team","href":"/api-reference/assistants/list-team-assistants"},{"title":"Get assistant version history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/{id}/history","href":"/api-reference/assistants/get-assistant-version-history"},{"title":"Search assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/query","href":"/api-reference/assistants/search-assistants"},{"title":"Set an assistant image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/image","href":"/api-reference/assistants/set-an-assistant-image"},{"title":"Rate an assistant definition","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/rate","href":"/api-reference/assistants/rate-an-assistant-definition"},{"title":"Steer running assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/steer","href":"/api-reference/assistants/steer-running-assistants"},{"title":"Get an assistant session","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent-session/{id}","href":"/api-reference/assistants/get-an-assistant-session"},{"title":"Set a session unread","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/set-agent-session-unread","href":"/api-reference/assistants/set-a-session-unread"},{"title":"Add session members","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/add-agent-session-members","href":"/api-reference/assistants/add-session-members"},{"title":"Save assistant learning","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json put /hub/agent/learning/{id}","href":"/api-reference/assistants/save-assistant-learning"},{"title":"Get an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent-interaction/{id}","href":"/api-reference/assistants/get-an-assistant-interaction"},{"title":"Update an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json put /hub/agent-interaction/{id}","href":"/api-reference/assistants/update-an-assistant-interaction"},{"title":"Delete an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json delete /hub/agent-interaction/{id}","href":"/api-reference/assistants/delete-an-assistant-interaction"},{"title":"Record an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent-interaction","href":"/api-reference/assistants/record-an-assistant-interaction"},{"title":"Resolve an escalation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/resolve-escalation","href":"/api-reference/assistants/resolve-an-escalation"},{"title":"Autocomplete a place","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/places-autocomplete","href":"/api-reference/assistants/autocomplete-a-place"},{"title":"Get place details","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/places-details","href":"/api-reference/assistants/get-place-details"}]},{"group":"MCP servers","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/mcp","href":"/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create an MCP server from an OpenAPI spec","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/mcp","href":"/api-reference/mcp-servers/create-an-mcp-server-from-an-openapi-spec"},{"title":"Get an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/mcp/{id}","href":"/api-reference/mcp-servers/get-an-mcp-server"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json delete /hub/agent/mcp/{id}","href":"/api-reference/mcp-servers/delete-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json patch /hub/agent/mcp/{id}","href":"/api-reference/mcp-servers/update-an-mcp-server"},{"title":"Create an MCP server from a Postman collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/mcp-postman-collection","href":"/api-reference/mcp-servers/create-an-mcp-server-from-a-postman-collection"},{"title":"Convert an MCP tool to JSON schema","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/mcp-json-schema","href":"/api-reference/mcp-servers/convert-an-mcp-tool-to-json-schema"},{"title":"Bind OAuth to an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/mcp/server-oauth","href":"/api-reference/mcp-servers/bind-oauth-to-an-mcp-server"},{"title":"Validate an OpenAPI document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/validate-openapi-schema","href":"/api-reference/mcp-servers/validate-an-openapi-document"}]}]},{"group":"Gateway","pages":[{"group":"Gateways","pages":[{"title":"Create a new gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway","href":"/api-reference/gateways/create-a-new-gateway"},{"title":"Get a specific gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}","href":"/api-reference/gateways/get-a-specific-gateway"},{"title":"Delete a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/{gateway_topic}","href":"/api-reference/gateways/delete-a-gateway"},{"title":"Update a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/{gateway_topic}","href":"/api-reference/gateways/update-a-gateway"},{"title":"Get all gateways","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/all","href":"/api-reference/gateways/get-all-gateways"}]},{"group":"Mappings","pages":[{"title":"Get all mappings for a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/mapping","href":"/api-reference/mappings/get-all-mappings-for-a-gateway"},{"title":"Create a new mapping for a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/{gateway_topic}/mapping","href":"/api-reference/mappings/create-a-new-mapping-for-a-gateway"},{"title":"Get a specific mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/mapping/details","href":"/api-reference/mappings/get-a-specific-mapping"},{"title":"Delete a mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/{gateway_topic}/mapping/details","href":"/api-reference/mappings/delete-a-mapping"},{"title":"Update a mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/{gateway_topic}/mapping/details","href":"/api-reference/mappings/update-a-mapping"},{"title":"Get all mappings","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/mapping/all","href":"/api-reference/mappings/get-all-mappings"}]},{"group":"Mapping Versions","pages":[{"title":"Get all versions for a mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/mapping/version","href":"/api-reference/mapping-versions/get-all-versions-for-a-mapping"},{"title":"Create a new mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/{gateway_topic}/mapping/version","href":"/api-reference/mapping-versions/create-a-new-mapping-version"},{"title":"Get a specific mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/mapping-version/{gateway_topic}/{version_number}","href":"/api-reference/mapping-versions/get-a-specific-mapping-version"},{"title":"Delete a mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/mapping-version/{gateway_topic}/{version_number}","href":"/api-reference/mapping-versions/delete-a-mapping-version"},{"title":"Update a mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/mapping-version/{gateway_topic}/{version_number}","href":"/api-reference/mapping-versions/update-a-mapping-version"},{"title":"Get all mapping versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/mapping-version/all","href":"/api-reference/mapping-versions/get-all-mapping-versions"}]},{"group":"DNS Zones","pages":[{"title":"Create a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/dns-zone","href":"/api-reference/dns-zones/create-a-dns-zone"},{"title":"List DNS zones","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/all","href":"/api-reference/dns-zones/list-dns-zones"},{"title":"Get a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/{zone_id}","href":"/api-reference/dns-zones/get-a-dns-zone"},{"title":"Delete a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/dns-zone/{zone_id}","href":"/api-reference/dns-zones/delete-a-dns-zone"},{"title":"Update a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/dns-zone/{zone_id}","href":"/api-reference/dns-zones/update-a-dns-zone"}]},{"group":"DNS Records","pages":[{"title":"List DNS records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/{zone_id}/record","href":"/api-reference/dns-records/list-dns-records"},{"title":"Create a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/dns-zone/{zone_id}/record","href":"/api-reference/dns-records/create-a-dns-record"},{"title":"Get a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/{zone_id}/record/{record_id}","href":"/api-reference/dns-records/get-a-dns-record"},{"title":"Delete a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/dns-zone/{zone_id}/record/{record_id}","href":"/api-reference/dns-records/delete-a-dns-record"},{"title":"Update a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/dns-zone/{zone_id}/record/{record_id}","href":"/api-reference/dns-records/update-a-dns-record"},{"title":"List a gateway's domains","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/dns-records","href":"/api-reference/dns-records/list-a-gateways-domains"}]},{"group":"Certificates","pages":[{"title":"Get a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/get-a-certificate"},{"title":"Request a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/request-a-certificate"},{"title":"Revoke a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/revoke-a-certificate"},{"title":"Renew a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/renew-a-certificate"}]}]},{"group":"Storage","pages":[{"group":"KV Buckets","pages":[{"title":"List all KV buckets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv","href":"/api-reference/kv-buckets/list-all-kv-buckets"},{"title":"Create a new KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/kv","href":"/api-reference/kv-buckets/create-a-new-kv-bucket"},{"title":"Get KV bucket details","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}","href":"/api-reference/kv-buckets/get-kv-bucket-details"},{"title":"Create or update a KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/kv/{bucket}","href":"/api-reference/kv-buckets/create-or-update-a-kv-bucket"},{"title":"Delete KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}","href":"/api-reference/kv-buckets/delete-kv-bucket"},{"title":"Purge KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}/purge","href":"/api-reference/kv-buckets/purge-kv-bucket"}]},{"group":"KV Entries","pages":[{"title":"Get latest KV entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}/entries","href":"/api-reference/kv-entries/get-latest-kv-entries"},{"title":"Create or update several KV entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/kv/{bucket}/entries","href":"/api-reference/kv-entries/create-or-update-several-kv-entries"},{"title":"Delete several KV entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}/entries","href":"/api-reference/kv-entries/delete-several-kv-entries"},{"title":"Get KV entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}/entries/{key}","href":"/api-reference/kv-entries/get-kv-entry"},{"title":"Create or update KV entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/kv/{bucket}/entries/{key}","href":"/api-reference/kv-entries/create-or-update-kv-entry"},{"title":"Delete KV entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}/entries/{key}","href":"/api-reference/kv-entries/delete-kv-entry"}]},{"group":"KV Search","pages":[{"title":"Search KV entries by key pattern","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}/search-by-key","href":"/api-reference/kv-search/search-kv-entries-by-key-pattern"}]},{"group":"Object Store","pages":[{"title":"List all object store buckets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj","href":"/api-reference/object-store/list-all-object-store-buckets"},{"title":"Create object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/obj","href":"/api-reference/object-store/create-object-store-bucket"},{"title":"Get an object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj/{bucket}","href":"/api-reference/object-store/get-an-object-store-bucket"},{"title":"Create or update object store","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/obj/{bucket}","href":"/api-reference/object-store/create-or-update-object-store"},{"title":"Delete an object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}","href":"/api-reference/object-store/delete-an-object-store-bucket"},{"title":"Purge object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}/purge","href":"/api-reference/object-store/purge-object-store-bucket"},{"title":"List object store entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj/{bucket}/entries","href":"/api-reference/object-store/list-object-store-entries"},{"title":"Delete several object store entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}/entries","href":"/api-reference/object-store/delete-several-object-store-entries"},{"title":"Get an object store entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj/{bucket}/entries/{key}","href":"/api-reference/object-store/get-an-object-store-entry"},{"title":"Delete an object store entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}/entries/{key}","href":"/api-reference/object-store/delete-an-object-store-entry"},{"title":"Sync an object store entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/obj/sync","href":"/api-reference/object-store/sync-an-object-store-entry"}]},{"group":"Streams","pages":[{"title":"List all streams","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/streams","href":"/api-reference/streams/list-all-streams"},{"title":"Create a new stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/streams","href":"/api-reference/streams/create-a-new-stream"},{"title":"Get information about a stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/streams/{name}","href":"/api-reference/streams/get-information-about-a-stream"},{"title":"Create or update a stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/streams/{name}","href":"/api-reference/streams/create-or-update-a-stream"},{"title":"Delete a stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/streams/{name}","href":"/api-reference/streams/delete-a-stream"},{"title":"Purge stream messages","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/stream/{name}/purge","href":"/api-reference/streams/purge-stream-messages"}]},{"group":"Messages","pages":[{"title":"Publish message to stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/streams/{name}/messages","href":"/api-reference/messages/publish-message-to-stream"},{"title":"Deletes stream messages","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/streams/{name}/messages","href":"/api-reference/messages/deletes-stream-messages"}]},{"group":"Stream Search","pages":[{"title":"Search stream messages by subject pattern","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/streams/{stream}/search-by-subject","href":"/api-reference/stream-search/search-stream-messages-by-subject-pattern"}]},{"group":"Agent Sessions","pages":[{"title":"List an assistant session's files","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files","href":"/api-reference/agent-sessions/list-an-assistant-sessions-files"},{"title":"Add a file to an assistant session","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/agent-sessions/{session_id}/files","href":"/api-reference/agent-sessions/add-a-file-to-an-assistant-session"},{"title":"Read a session file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files/{key}","href":"/api-reference/agent-sessions/read-a-session-file"},{"title":"Overwrite a session file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/agent-sessions/{session_id}/files/{key}","href":"/api-reference/agent-sessions/overwrite-a-session-file"},{"title":"List a session file's versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files/{key}/versions","href":"/api-reference/agent-sessions/list-a-session-files-versions"},{"title":"Read an archived session file version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files/{key}/versions/{content_key}","href":"/api-reference/agent-sessions/read-an-archived-session-file-version"},{"title":"List a session's stored tool responses","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/tool-responses","href":"/api-reference/agent-sessions/list-a-sessions-stored-tool-responses"},{"title":"Read a stored tool response","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/tool-responses/{key}","href":"/api-reference/agent-sessions/read-a-stored-tool-response"}]},{"group":"Index","pages":[{"title":"Query a search index","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/index/{name}/query","href":"/api-reference/index/query-a-search-index"}]}]},{"group":"Trigger","pages":[{"group":"Triggers","pages":[{"title":"Retrieve all triggers","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json get /trigger/triggers","href":"/api-reference/triggers/retrieve-all-triggers"},{"title":"Retrieve a specific trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json get /trigger/triggers/{trigger_type}/{topic}","href":"/api-reference/triggers/retrieve-a-specific-trigger"},{"title":"Delete a trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json delete /trigger/triggers/{trigger_type}/{topic}","href":"/api-reference/triggers/delete-a-trigger"},{"title":"Update a trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json patch /trigger/triggers/{trigger_type}/{topic}","href":"/api-reference/triggers/update-a-trigger"}]},{"group":"Gateway Triggers","pages":[{"title":"Create a gateway trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/gateway","href":"/api-reference/gateway-triggers/create-a-gateway-trigger"}]},{"group":"Stream Triggers","pages":[{"title":"Create a stream trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/stream","href":"/api-reference/stream-triggers/create-a-stream-trigger"}]},{"group":"Object Store Triggers","pages":[{"title":"Create an object store trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/obj","href":"/api-reference/object-store-triggers/create-an-object-store-trigger"}]},{"group":"Email Triggers","pages":[{"title":"Create an email trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/email","href":"/api-reference/email-triggers/create-an-email-trigger"}]},{"group":"Email triggers","pages":[{"title":"Search received emails","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/emails/search","href":"/api-reference/email-triggers/search-received-emails"},{"title":"Get a received email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json get /trigger/emails/{uid}","href":"/api-reference/email-triggers/get-a-received-email"},{"title":"Delete a received email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json delete /trigger/emails/{uid}","href":"/api-reference/email-triggers/delete-a-received-email"},{"title":"Re-run the flow for an email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/emails/{uid}/trigger","href":"/api-reference/email-triggers/re-run-the-flow-for-an-email"}]}]},{"group":"Monitoring","pages":[{"group":"metrics","pages":[{"title":"Get metric statistics over time","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/monitoring/openapi.json get /monitoring/metrics/{metric}/stats","href":"/api-reference/metrics/get-metric-statistics-over-time"},{"title":"Get current metric value","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/monitoring/openapi.json get /monitoring/metrics/{metric}/current","href":"/api-reference/metrics/get-current-metric-value"},{"title":"Get multiple current metric values","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/monitoring/openapi.json post /monitoring/metrics/current","href":"/api-reference/metrics/get-multiple-current-metric-values"}]}]},{"group":"Microsoft 365","pages":[{"group":"Mail","pages":[{"title":"Start connecting the caller's mailbox","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/connect-url","href":"/api-reference/mail/start-connecting-the-callers-mailbox"},{"title":"Record a connect error that needs admin approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/mail/connect-result","href":"/api-reference/mail/record-a-connect-error-that-needs-admin-approval"},{"title":"Get the caller's mailbox connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/connection","href":"/api-reference/mail/get-the-callers-mailbox-connection"},{"title":"Disconnect the caller's mailbox","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/mail/connection","href":"/api-reference/mail/disconnect-the-callers-mailbox"},{"title":"Update the caller's mailbox connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json patch /m365/mail/connection","href":"/api-reference/mail/update-the-callers-mailbox-connection"},{"title":"List who has connected mail","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/connections","href":"/api-reference/mail/list-who-has-connected-mail"},{"title":"Remove a member's mailbox","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/mail/connections/{user_id}","href":"/api-reference/mail/remove-a-members-mailbox"},{"title":"List the caller's mail folders","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/folders","href":"/api-reference/mail/list-the-callers-mail-folders"},{"title":"Get the tenant admin-consent URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/consent-url","href":"/api-reference/mail/get-the-tenant-admin-consent-url"},{"title":"Mail admin-consent callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/consent-callback","href":"/api-reference/mail/mail-admin-consent-callback"}]},{"group":"Mail filing","pages":[{"title":"List mail filters and automations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/filings","href":"/api-reference/mail-filing/list-mail-filters-and-automations"},{"title":"Create a mail filter or automation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/mail/filings","href":"/api-reference/mail-filing/create-a-mail-filter-or-automation"},{"title":"Stop a mail filter or automation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/mail/filings/{id}","href":"/api-reference/mail-filing/stop-a-mail-filter-or-automation"},{"title":"Update a mail filter or automation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json patch /m365/mail/filings/{id}","href":"/api-reference/mail-filing/update-a-mail-filter-or-automation"},{"title":"Recent inbox items for the filing picker","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/recent","href":"/api-reference/mail-filing/recent-inbox-items-for-the-filing-picker"}]},{"group":"Mail automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/automations","href":"/api-reference/mail-automations/list-automations"},{"title":"List an automation's runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/automations/{id}/runs","href":"/api-reference/mail-automations/list-an-automations-runs"},{"title":"Get the actions run on a filed message","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/activity","href":"/api-reference/mail-automations/get-the-actions-run-on-a-filed-message"}]},{"group":"Files connection","pages":[{"title":"Get the files admin-consent URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/consent-url","href":"/api-reference/files-connection/get-the-files-admin-consent-url"},{"title":"Files admin-consent callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/consent-callback","href":"/api-reference/files-connection/files-admin-consent-callback"},{"title":"Get the files admin sign-in URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/admin-auth-url","href":"/api-reference/files-connection/get-the-files-admin-sign-in-url"},{"title":"Files admin sign-in callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/admin-callback","href":"/api-reference/files-connection/files-admin-sign-in-callback"},{"title":"Get the files connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/connection","href":"/api-reference/files-connection/get-the-files-connection"}]},{"group":"SharePoint browse","pages":[{"title":"Search SharePoint sites","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/browse/sites","href":"/api-reference/sharepoint-browse/search-sharepoint-sites"},{"title":"List document libraries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/browse/drives","href":"/api-reference/sharepoint-browse/list-document-libraries"},{"title":"List folders in a library","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/browse/children","href":"/api-reference/sharepoint-browse/list-folders-in-a-library"}]},{"group":"SharePoint sync sources","pages":[{"title":"List sync sources","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources","href":"/api-reference/sharepoint-sync-sources/list-sync-sources"},{"title":"Create a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/sources","href":"/api-reference/sharepoint-sync-sources/create-a-sync-source"},{"title":"Get a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources/{id}","href":"/api-reference/sharepoint-sync-sources/get-a-sync-source"},{"title":"Remove a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/sources/{id}","href":"/api-reference/sharepoint-sync-sources/remove-a-sync-source"},{"title":"Update a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json patch /m365/sources/{id}","href":"/api-reference/sharepoint-sync-sources/update-a-sync-source"},{"title":"Sync a source now","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/sources/{id}/run","href":"/api-reference/sharepoint-sync-sources/sync-a-source-now"},{"title":"Get a sync run","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources/{id}/runs/{run_id}","href":"/api-reference/sharepoint-sync-sources/get-a-sync-run"},{"title":"List sync runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources/{id}/runs","href":"/api-reference/sharepoint-sync-sources/list-sync-runs"}]}]},{"group":"Distribution","pages":[{"group":"Distribution Invitations","pages":[{"title":"Create a distribution invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-invite","href":"/api-reference/distribution-invitations/create-a-distribution-invitation"},{"title":"Withdraw a distribution invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json delete /accounts/distribution-invite","href":"/api-reference/distribution-invitations/withdraw-a-distribution-invitation"},{"title":"List outstanding invitations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-invites","href":"/api-reference/distribution-invitations/list-outstanding-invitations"},{"title":"Email an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/send-distribution-invite","href":"/api-reference/distribution-invitations/email-an-invitation"},{"title":"Resend or reopen an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/resend-distribution-invite","href":"/api-reference/distribution-invitations/resend-or-reopen-an-invitation"},{"title":"Re-fetch an invitation link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-invite-link","href":"/api-reference/distribution-invitations/re-fetch-an-invitation-link"},{"title":"Preview an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/preview-distribution-invite","href":"/api-reference/distribution-invitations/preview-an-invitation"},{"title":"Redeem an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/redeem-distribution-invite","href":"/api-reference/distribution-invitations/redeem-an-invitation"},{"title":"Get the invitation an account signed up from","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/pending-distribution-invite","href":"/api-reference/distribution-invitations/get-the-invitation-an-account-signed-up-from"},{"title":"List invitations addressed to me","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-invite-inbox","href":"/api-reference/distribution-invitations/list-invitations-addressed-to-me"},{"title":"Get the link for an invitation addressed to me","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-invite-inbox-link","href":"/api-reference/distribution-invitations/get-the-link-for-an-invitation-addressed-to-me"}]},{"group":"Distribution Register","pages":[{"title":"Check a distribution is provisioned","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-status","href":"/api-reference/distribution-register/check-a-distribution-is-provisioned"},{"title":"Get one distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution","href":"/api-reference/distribution-register/get-one-distribution"},{"title":"Amend a distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json patch /accounts/distribution","href":"/api-reference/distribution-register/amend-a-distribution"},{"title":"List distributions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distributions","href":"/api-reference/distribution-register/list-distributions"},{"title":"Get the link to a counterparty","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-link","href":"/api-reference/distribution-register/get-the-link-to-a-counterparty"},{"title":"Reprovision a distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-reprovision","href":"/api-reference/distribution-register/reprovision-a-distribution"},{"title":"Get the distributor firm behind a grant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-brokerage","href":"/api-reference/distribution-register/get-the-distributor-firm-behind-a-grant"},{"title":"List distributors a product can be sent to","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-connected-accounts","href":"/api-reference/distribution-register/list-distributors-a-product-can-be-sent-to"}]},{"group":"Distributor Setup","pages":[{"title":"Get a distributor's features","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distributor-features","href":"/api-reference/distributor-setup/get-a-distributors-features"},{"title":"Replace a distributor's feature overrides","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json put /accounts/distributor-features","href":"/api-reference/distributor-setup/replace-a-distributors-feature-overrides"},{"title":"Set the distributor space template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distributor-space-template","href":"/api-reference/distributor-setup/set-the-distributor-space-template"},{"title":"Clear the distributor space template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json delete /accounts/distributor-space-template","href":"/api-reference/distributor-setup/clear-the-distributor-space-template"}]},{"group":"Distribution Products","pages":[{"title":"Publish a record set definition","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/product-definition","href":"/api-reference/distribution-products/publish-a-record-set-definition"},{"title":"List definition versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/product-definitions","href":"/api-reference/distribution-products/list-definition-versions"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-product","href":"/api-reference/distribution-products/get-a-product"},{"title":"Publish a product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-product","href":"/api-reference/distribution-products/publish-a-product"},{"title":"Publish the next product version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json patch /accounts/distribution-product","href":"/api-reference/distribution-products/publish-the-next-product-version"},{"title":"List my products","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-products","href":"/api-reference/distribution-products/list-my-products"},{"title":"List products granted by a publisher","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-granted-products","href":"/api-reference/distribution-products/list-products-granted-by-a-publisher"},{"title":"Sync products to distributors","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-products-sync","href":"/api-reference/distribution-products/sync-products-to-distributors"},{"title":"Clear stored space cards","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-clear-space-cards","href":"/api-reference/distribution-products/clear-stored-space-cards"}]},{"group":"Distribution Messages","pages":[{"title":"Send a distribution message","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-message","href":"/api-reference/distribution-messages/send-a-distribution-message"}]},{"group":"Config Reservations","pages":[{"title":"Release a config id","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json delete /accounts/config-reservation","href":"/api-reference/config-reservations/release-a-config-id"},{"title":"List my config id reservations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/config-reservations","href":"/api-reference/config-reservations/list-my-config-id-reservations"}]}]},{"group":"Abbie (beta)","pages":[{"group":"Skills","pages":[{"title":"List builtin and user-defined skills","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/skills","href":"/api-reference/skills/list-builtin-and-user-defined-skills"},{"title":"Dry-run skill activation against a message","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/skill/test","href":"/api-reference/skills/dry-run-skill-activation-against-a-message"},{"title":"List skill drafts awaiting review","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/skill-drafts","href":"/api-reference/skills/list-skill-drafts-awaiting-review"},{"title":"Read the account's script-execution opt-in","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/skill-exec","href":"/api-reference/skills/read-the-accounts-script-execution-opt-in"}]},{"group":"Todos","pages":[{"title":"List the caller's backlog (personal + organisation)","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/todos","href":"/api-reference/todos/list-the-callers-backlog-personal-+-organisation"},{"title":"Update one backlog item","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/todo","href":"/api-reference/todos/update-one-backlog-item"},{"title":"Promote a backlog item to a workspace task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/todo/promote/task","href":"/api-reference/todos/promote-a-backlog-item-to-a-workspace-task"},{"title":"Read the default space for promoted tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/task-space","href":"/api-reference/todos/read-the-default-space-for-promoted-tasks"},{"title":"Set the default space for promoted tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/task-space","href":"/api-reference/todos/set-the-default-space-for-promoted-tasks"}]},{"group":"Memory","pages":[{"title":"List memories","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/org-memories","href":"/api-reference/memory/list-memories"},{"title":"Create a memory","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/org-memory","href":"/api-reference/memory/create-a-memory"},{"title":"Update a memory","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/org-memory/{id}","href":"/api-reference/memory/update-a-memory"},{"title":"Delete a memory","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json delete /hub/coworker/org-memory/{id}","href":"/api-reference/memory/delete-a-memory"},{"title":"Read the memory-consolidation setting","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/memory-consolidation","href":"/api-reference/memory/read-the-memory-consolidation-setting"}]},{"group":"Profile and personality","pages":[{"title":"Read the account's organisation profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/profile","href":"/api-reference/profile-and-personality/read-the-accounts-organisation-profile"},{"title":"Set the account's organisation profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/profile","href":"/api-reference/profile-and-personality/set-the-accounts-organisation-profile"},{"title":"Read your own personal profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/personal-profile","href":"/api-reference/profile-and-personality/read-your-own-personal-profile"},{"title":"Set your own personal profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/personal-profile","href":"/api-reference/profile-and-personality/set-your-own-personal-profile"},{"title":"Read the account's voice layer","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/personality","href":"/api-reference/profile-and-personality/read-the-accounts-voice-layer"}]},{"group":"Corrections","pages":[{"title":"Read your own corrections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/corrections","href":"/api-reference/corrections/read-your-own-corrections"},{"title":"Replace your own corrections list","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/corrections","href":"/api-reference/corrections/replace-your-own-corrections-list"},{"title":"Read the organisation's corrections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/org-corrections","href":"/api-reference/corrections/read-the-organisations-corrections"},{"title":"List proposed corrections awaiting your decision","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/correction-drafts","href":"/api-reference/corrections/list-proposed-corrections-awaiting-your-decision"}]},{"group":"Environment","pages":[{"title":"List declared environment variables","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/env","href":"/api-reference/environment/list-declared-environment-variables"},{"title":"Replace an existing environment variable","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/env","href":"/api-reference/environment/replace-an-existing-environment-variable"},{"title":"Declare a new environment variable","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/env","href":"/api-reference/environment/declare-a-new-environment-variable"},{"title":"Remove an environment variable","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json delete /hub/coworker/env","href":"/api-reference/environment/remove-an-environment-variable"}]},{"group":"Models","pages":[{"title":"Merged model catalogue","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/model-catalog","href":"/api-reference/models/merged-model-catalogue"},{"title":"Read the account's model pool configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/agent/model-pool","href":"/api-reference/models/read-the-accounts-model-pool-configuration"}]}]}]},{"tab":"Change Log","pages":[{"title":"Change Log","href":"/changelog/product-updates"}]}]},"basePath":"","title":"Create template - QuivaWorks Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}