View our documentation on the API, SDK, or Integrations here!
API
Get started with the Artos API!
SDK
Get started with the Artos SDK!
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Artos Documentation","colors":{"primary":"#1F477D","light":"#4085F5","dark":"#1F477D"},"logo":{"light":"https://mintcdn.com/artos/3kjmhJ2FENUv4B6g/logo/favicon.ico?fit=max\u0026auto=format\u0026n=3kjmhJ2FENUv4B6g\u0026q=85\u0026s=771b7c68ead320348ff7c9b65f87c6b3","dark":"https://mintcdn.com/artos/3kjmhJ2FENUv4B6g/logo/favicon.ico?fit=max\u0026auto=format\u0026n=3kjmhJ2FENUv4B6g\u0026q=85\u0026s=771b7c68ead320348ff7c9b65f87c6b3"},"favicon":{"light":"https://mintcdn.com/artos/jWF-EjGxpiPX0dAF/images/LOGO.png?fit=max\u0026auto=format\u0026n=jWF-EjGxpiPX0dAF\u0026q=85\u0026s=54d1179793f0933ed95ff24740a6fe76","dark":"https://mintcdn.com/artos/jWF-EjGxpiPX0dAF/images/LOGO.png?fit=max\u0026auto=format\u0026n=jWF-EjGxpiPX0dAF\u0026q=85\u0026s=54d1179793f0933ed95ff24740a6fe76"},"navbar":{"links":[{"href":"mailto:internal@artosai.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://artosai.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/artosai"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.artosai.com"},{"anchor":"Website","icon":"slack","href":"https://artosai.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"artos","hasAudioNarration":false,"actualSubdomain":"artos","customDomains":["docs.artosai.com"],"gitSource":{"type":"github","owner":"artosai","repo":"artos-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a7ac1471a823fc837f78de0","collectionId":"4af6321e-186a-44bb-a570-14d4ea395d23","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a7ac1471a823fc837f78de0"},"entitlements":{},"buildId":"6a7ac1471a823fc837f78de0:success","clientVersion":"0.0.3869","searchFilterCounts":[{"language":"default","tag":"Documentation","count":38},{"language":"default","tag":"API Reference","count":33},{"language":"default","tag":"Deployment","count":10},{"language":"default","tag":"AWS Modules","count":8},{"language":"default","tag":"Templates","count":8},{"language":"default","tag":"Integrations","count":7},{"language":"default","tag":"NPM SDK Reference","count":6},{"language":"default","tag":"Files","count":6},{"language":"default","tag":"Documents","count":5},{"language":"default","tag":"Core Concepts","count":4}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Introduction","description":"Welcome to the Artos API/SDK Documentation","href":"/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Welcome to the Artos API/SDK Documentation\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting Started`}),`\n`,_jsx(_components.p,{children:`View our documentation on the API, SDK, or Integrations here!`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`API`,icon:`pen-to-square`,href:`https://docs.artosai.com/api-reference/introduction`,children:_jsx(_components.p,{children:`Get started with the Artos API!`})}),_jsx(Card,{title:`SDK`,icon:`image`,href:`https://docs.artosai.com/sdk-reference/installation`,children:_jsx(_components.p,{children:`Get started with the Artos SDK!`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"Welcome to the Artos API/SDK Documentation","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting Started","slug":"getting-started","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"artos","siteName":"Artos Documentation","title":"Introduction - Artos Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T04:53:19.390Z","originalFileLocation":"index.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Welcome to the Artos API/SDK Documentation\">\u003cmeta data-mint-head name=\"application-name\" content=\"Artos Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/artos/_qn-xOME9DonUu9N/_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/artos/_qn-xOME9DonUu9N/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/artos/_qn-xOME9DonUu9N/_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/artos/_qn-xOME9DonUu9N/_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/artos/_qn-xOME9DonUu9N/_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/artos/_qn-xOME9DonUu9N/_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/artos/_qn-xOME9DonUu9N/_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/artos/_qn-xOME9DonUu9N/_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/artos/_qn-xOME9DonUu9N/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Artos Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Artos API/SDK Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Artos Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.artosai.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Artos Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Artos API/SDK Documentation\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/artos/_qn-xOME9DonUu9N/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Artos Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F477D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.artosai.com\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Artos Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Artos Documentation","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.artosai.com"},{"anchor":"Website","icon":"slack","href":"https://artosai.com"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","description":"Artos API for document generation, template management, and search","href":"/api-reference/introduction"},{"title":"Authentication","description":"Authenticate Artos API requests with an Okta access-token JWT.","href":"/api-reference/authentication"}]},{"group":"API Reference","pages":[{"title":"Files API","description":"Upload and retrieve files from S3","href":"/api-reference/files"},{"title":"Documents API","description":"Generate and retrieve documents using templates","href":"/api-reference/documents"},{"title":"Document Sets API","description":"Manage workspaces that group related documents","href":"/api-reference/document-sets"},{"title":"Document Details API","description":"Update and retrieve document-specific section and rule details","href":"/api-reference/document-mrt"},{"title":"Outlines API","description":"Manage document outlines with nested sections","href":"/api-reference/mrt-outlines"},{"title":"Templates API","description":"Create and manage templates with nested sections and extraction rules","href":"/api-reference/templates"},{"title":"Error Handling","description":"Understanding and handling API error responses","href":"/api-reference/errors"}]},{"group":"Core Concepts","pages":[{"title":"Template Workflow","description":"Understanding templates and their structure","href":"/concepts/mrt-workflow"},{"title":"Document Generation","description":"Understanding the document generation process","href":"/concepts/document-generation"},{"title":"Async Operations","description":"Understanding asynchronous processing patterns","href":"/concepts/async-operations"},{"title":"Organization Model","description":"Understanding Artos multi-tenancy and organization scoping","href":"/concepts/organization-model"}]},{"group":"Single-Tenant","pages":[{"title":"Okta JWT Authentication","description":"Use an Okta access-token JWT with Artos in a single-tenant environment.","href":"/single-tenant/okta-jwt"}]},{"group":"Cookbooks","pages":[{"title":"Template and Document Generation Cookbook","description":"Complete guide to auto-generating templates from examples and generating documents with practical examples","href":"/cookbooks/template-generation"}]},{"group":"NPM SDK Reference","pages":[{"title":"npm SDK Installation","description":"Install and configure the Artos npm SDK (@artosai/sdk) for JavaScript and TypeScript applications.","href":"/sdk-reference/npm-installation"},{"title":"npm SDK Authentication","description":"Authenticate the Artos npm SDK with an Okta access-token JWT.","href":"/sdk-reference/npm-auth-setup"},{"title":"npm SDK API Reference","description":"Resource and document-session methods in the Artos npm SDK.","href":"/sdk-reference/npm-api-reference"},{"title":"npm SDK File Loading","description":"Open templates, documents, source files, and OnlyOffice resources with the Artos npm SDK.","href":"/sdk-reference/npm-file-loading"},{"title":"npm SDK Breadcrumbs","description":"Read section-rule breadcrumbs, metadata, and referenced resources with the Artos npm SDK.","href":"/sdk-reference/npm-breadcrumbs"},{"title":"npm SDK Error Handling","description":"Handle errors and debug issues when using the Artos npm SDK (@artosai/sdk).","href":"/sdk-reference/npm-error-handling"}]},{"group":"Integrations","pages":[{"title":"Model Context Protocol (MCP)","description":"The SDK acts as an MCP client to connect to external MCP servers, providing access to file systems, databases, and APIs through standardized interfaces.","href":"/integrations/mcp"},{"title":"Databases","description":"Direct database connections for data ingestion and processing via Artos connectors ","href":"/integrations/database"},{"title":"Notifications","description":"Configure notifications for Artos services via email, Slack, or Teams","href":"/integrations/notifications"},{"title":"Document Management Systems","description":"Integration with enterprise document management platforms.","href":"/integrations/document-management"},{"title":"Frontend Customization Components","description":"Embed the Artos platform directly into your applications with complete customization control","href":"/integrations/frontend-customization"},{"title":"Debugging and Analytics","description":"Debug workflows, monitor performance, and optimize your Artos implementations with comprehensive analytics","href":"/integrations/debugging-analytics"},{"title":"Platform Integration","description":"Integrate Artos into your existing systems with the 'best of both worlds' approach","href":"/integrations/platform-integration"}]},{"group":"Deployment","pages":[{"group":"Deployment Guide","pages":[{"title":"Deployment Steps","description":"High level deployment steps to deploy the Artos platform","href":"/deployment/deployment_steps/deployment_steps"}]},{"group":"Global Resources","pages":[{"title":"Global AWS Resources","description":"Shared AWS infrastructure resources for Artos deployment across all environments","href":"/deployment/global_resources/global_aws_resources"}]},{"group":"AWS Modules","pages":[{"title":"Bastion Host Module","description":"Secure access to EKS clusters using AWS Systems Manager Session Manager","href":"/deployment/modules/bastion"},{"title":"ECR Module","description":"Amazon Elastic Container Registry repositories for Artos application images","href":"/deployment/modules/ecr"},{"title":"EKS Module","description":"Amazon Elastic Kubernetes Service cluster with managed node groups and Fargate support","href":"/deployment/modules/eks"},{"title":"IAM Module","description":"IAM roles and policies for Artos application components using OIDC-based Kubernetes service accounts","href":"/deployment/modules/iam"},{"title":"Monitoring Module","description":"CloudWatch logging, metrics, alarms, and dashboards for Artos platform observability","href":"/deployment/modules/monitoring"},{"title":"Networking Module","description":"VPC, subnets, security groups, and VPC endpoints for secure private cloud deployment","href":"/deployment/modules/networking"},{"title":"RDS Module","description":"Amazon Aurora PostgreSQL database cluster with automated backups, encryption, and high availability","href":"/deployment/modules/rds"},{"title":"S3 Module","description":"Amazon S3 storage for documents, files, and static assets with encryption, versioning, and lifecycle management","href":"/deployment/modules/s3"}]}]}]},{"tab":"API Reference","groups":[{"group":"Files","pages":[{"title":"Create Document File Session","description":"Authorize an opaque resource ID and create a short-lived revocable session token for viewing the file. No S3 URL is returned.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /document-file-session","href":"/api-reference/files/create-document-file-session","autogeneratedByOpenApi":true},{"title":"Stream an Authorized Source File","description":"Streams a source file after authorizing its sourcefile- resource ID with the caller's Bearer token. This route does not accept or mint a document session token and is separate from the OnlyOffice flow.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /source-file","href":"/api-reference/files/stream-an-authorized-source-file","autogeneratedByOpenApi":true},{"title":"Create OnlyOffice Configuration","description":"Authorize a resource and return a server-generated OnlyOffice configuration. Use readonly mode for previews.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /generate-onlyoffice-config","href":"/api-reference/files/create-onlyoffice-configuration","autogeneratedByOpenApi":true},{"title":"Stream a Document Session","description":"Streams document bytes for a viewer using a short-lived session token sent in the Authorization header. A session token in the query string is rejected for ordinary downloads; the query form is reserved for the OnlyOffice server-to-server flow and requires a separate signed OnlyOffice JWT. This route does not accept S3 URLs or raw object keys.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /open-document","href":"/api-reference/files/stream-a-document-session","autogeneratedByOpenApi":true},{"title":"List Files","description":"List all files in a specific container for the authenticated user's organization. Returns file names and resource IDs. Resolve each resource ID through the authenticated document-session endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/files/{container}","href":"/api-reference/files/list-files","autogeneratedByOpenApi":true},{"title":"Upload File","description":"Upload a file to S3. Validates file type by extension/MIME. Auto-converts DOCX to PDF except in the templates container.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /api/v1/files/upload","href":"/api-reference/files/upload-file","autogeneratedByOpenApi":true}]},{"group":"Documents","pages":[{"title":"List Documents","description":"List all documents for the authenticated user. Internal/Owner role users see all documents in their organization. Other roles see only their own documents.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/documents/","href":"/api-reference/documents/list-documents","autogeneratedByOpenApi":true},{"title":"Generate Document","description":"Extract content from source documents, ingest, and orchestrate document generation using a template. Request is immediately queued as a background task and returns 202 Accepted. Poll `/api/v1/documents/status/{document_id}` for progress.\n\n**Field aliases** (both forms accepted):\n- `connector_data_id` = `document_set_key`\n- `template_id` = `generic_mrt_id`\n- `workspace_name` = `document_set_name`","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /api/v1/documents/generate","href":"/api-reference/documents/generate-document","autogeneratedByOpenApi":true},{"title":"Get Document Status","description":"Poll the status of a document being generated. Returns current processing state from the database.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/documents/status/{document_id}","href":"/api-reference/documents/get-document-status","autogeneratedByOpenApi":true},{"title":"Get Document","description":"Get a single document by ID with sections, sources, and metadata. Only returns documents belonging to the authenticated user's organization.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/documents/{document_id}","href":"/api-reference/documents/get-document","autogeneratedByOpenApi":true},{"title":"Get Sections for Document","description":"Retrieve a flat list of all section identifiers and their associated metadata within a given document. Used to enumerate the full section structure, enabling the Sources panel selection dropdown to be pre-populated with all available sections upon document load.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /get-sections-for-document","href":"/api-reference/documents/get-sections-for-document","autogeneratedByOpenApi":true}]},{"group":"Document Sets","pages":[{"title":"List Document Sets","description":"List all document sets for the authenticated user. Internal/Owner role users see all document sets in their organization.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/document-sets/","href":"/api-reference/document-sets/list-document-sets","autogeneratedByOpenApi":true},{"title":"Create Document Set","description":"Create a new document set associated to the authenticated user's organization. Creator is automatically added to the users array.\n\n**Field alias**: `workspace_name` is the primary field name; `document_set_name` is also accepted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /api/v1/document-sets/","href":"/api-reference/document-sets/create-document-set","autogeneratedByOpenApi":true},{"title":"Get Document Set","description":"Get a single document set by ID including all associated documents and users. Organization-scoped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/document-sets/{document_set_id}","href":"/api-reference/document-sets/get-document-set","autogeneratedByOpenApi":true}]},{"group":"Templates","pages":[{"title":"List Templates","description":"List all templates accessible to the authenticated user. Filtered by organization and user membership, sorted by creation date (newest first).","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/templates/","href":"/api-reference/templates/list-templates","autogeneratedByOpenApi":true},{"title":"Create Template","description":"Create a new template with nested sections and rules. Validates inputs and persists to database.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /api/v1/templates/","href":"/api-reference/templates/create-template","autogeneratedByOpenApi":true},{"title":"Get Template","description":"Retrieve a single template by ID with full details including sections and users.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/templates/{template_id}","href":"/api-reference/templates/get-template","autogeneratedByOpenApi":true},{"title":"Add Template Section","description":"Add a new section to an existing template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /api/v1/templates/{template_id}/sections","href":"/api-reference/templates/add-template-section","autogeneratedByOpenApi":true},{"title":"Delete Template Section","description":"Delete a section from a template with optional cascading of child sections. Database CASCADE handles deletion of associated rules.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /api/v1/templates/{template_id}/sections/{section_id}","href":"/api-reference/templates/delete-template-section","autogeneratedByOpenApi":true},{"title":"Rename Template Section","description":"Rename a section in an existing template. Provide the full new name (e.g., '2.1 Efficacy Results').","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /api/v1/templates/{template_id}/sections/{section_id}/rename","href":"/api-reference/templates/rename-template-section","autogeneratedByOpenApi":true},{"title":"Reorder Template Sections","description":"Reorder and renumber template sections. After applying the new positions, all section names are automatically renumbered to reflect the hierarchy (e.g., '1.', '1.1', '2.').","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /api/v1/templates/{template_id}/sections/reorder","href":"/api-reference/templates/reorder-template-sections","autogeneratedByOpenApi":true},{"title":"Update Rule Styles","description":"Update style names, fill color, and/or text color for a template section rule. Styles are returned automatically with the Get Template endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /api/v1/templates/{template_id}/rules/{rule_id}/styles","href":"/api-reference/templates/update-rule-styles","autogeneratedByOpenApi":true}]},{"group":"Outlines","pages":[{"title":"Get Outline","description":"Get a single outline by ID. Returns the complete outline including metadata and all sections ordered by index. Organization-scoped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/mrt-outlines/{outline_id}","href":"/api-reference/outlines/get-outline","autogeneratedByOpenApi":true},{"title":"Update Outline","description":"Full replacement (PUT) of an outline. All existing sections are deleted and replaced with the provided structure.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /api/v1/mrt-outlines/{outline_id}","href":"/api-reference/outlines/update-outline","autogeneratedByOpenApi":true}]},{"group":"Document Details","pages":[{"title":"Update Document Details","description":"Full replacement (PUT) of document details including metadata, sections, and rules. All existing sections and rules are deleted and replaced.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /api/v1/document-mrt/{mrt_id}","href":"/api-reference/document-details/update-document-details","autogeneratedByOpenApi":true},{"title":"Get Document Details by Document ID","description":"Get document details by parent document ID. Retrieves complete details with all sections and rules for the specified document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /api/v1/document-mrt/by-document/{document_id}","href":"/api-reference/document-details/get-document-details-by-document-id","autogeneratedByOpenApi":true}]}]}]},"title":"Introduction - Artos Documentation","buildId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","deploymentId":"dpl_DMQXxPZd444kjahHSuSB7FkJbKrX","dynamics":[],"chunks":[]}