# Artos Documentation

## Docs

- [Authentication](https://docs.artosai.com/api-reference/authentication.md): Artos API uses Bearer token authentication. All endpoints (except /search/status) require a valid Bearer token in the Authorization header.
- [Get Document Details by Document ID](https://docs.artosai.com/api-reference/document-details/get-document-details-by-document-id.md): Get document details by parent document ID. Retrieves complete details with all sections and rules for the specified document.
- [Update Document Details](https://docs.artosai.com/api-reference/document-details/update-document-details.md): Full replacement (PUT) of document details including metadata, sections, and rules. All existing sections and rules are deleted and replaced.
- [Document Details API](https://docs.artosai.com/api-reference/document-mrt.md): Update and retrieve document-specific section and rule details
- [Document Sets API](https://docs.artosai.com/api-reference/document-sets.md): Manage workspaces that group related documents
- [Create Document Set](https://docs.artosai.com/api-reference/document-sets/create-document-set.md): Create a new document set associated to the authenticated user's organization. Creator is automatically added to the users array.
- [Get Document Set](https://docs.artosai.com/api-reference/document-sets/get-document-set.md): Get a single document set by ID including all associated documents and users. Organization-scoped.
- [List Document Sets](https://docs.artosai.com/api-reference/document-sets/list-document-sets.md): List all document sets for the authenticated user. Internal/Owner role users see all document sets in their organization.
- [Documents API](https://docs.artosai.com/api-reference/documents.md): Generate and retrieve documents using templates
- [Generate Document](https://docs.artosai.com/api-reference/documents/generate-document.md): 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.
- [Get Document](https://docs.artosai.com/api-reference/documents/get-document.md): Get a single document by ID with sections, sources, and metadata. Only returns documents belonging to the authenticated user's organization.
- [Get Document Status](https://docs.artosai.com/api-reference/documents/get-document-status.md): Poll the status of a document being generated. Returns current processing state from the database.
- [Get Sections for Document](https://docs.artosai.com/api-reference/documents/get-sections-for-document.md): 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.
- [List Documents](https://docs.artosai.com/api-reference/documents/list-documents.md): List all documents for the authenticated user. Internal/Owner role users see all documents in their organization. Other roles see only their own documents.
- [Error Handling](https://docs.artosai.com/api-reference/errors.md): Understanding and handling API error responses
- [Files API](https://docs.artosai.com/api-reference/files.md): Upload and retrieve files from S3
- [Generate Presigned URL](https://docs.artosai.com/api-reference/files/generate-presigned-url.md): Generate a time-limited presigned S3 URL from an S3 object key. The returned URL expires after **1 hour** and can be used directly for download without an auth header.
- [List Files](https://docs.artosai.com/api-reference/files/list-files.md): List all files in a specific container for the authenticated user's organization. Returns file names and presigned S3 URLs that are ready for download. For browser/VPN-restricted clients, pass each returned URL to `GET /api/v1/proxy/file` as `presigned_url`.
- [Proxy Presigned File](https://docs.artosai.com/api-reference/files/proxy-presigned-file.md): Stream a file via backend using a presigned S3 URL. Useful when clients cannot access S3 directly (for example, VPN-restricted browsers). The URL is validated to allow only S3 hosts.
- [Upload File](https://docs.artosai.com/api-reference/files/upload-file.md): Upload a file to S3. Validates file type by extension/MIME. Auto-converts DOCX to PDF except in the templates container.
- [Introduction](https://docs.artosai.com/api-reference/introduction.md): Artos API for document generation, template management, and search
- [Outlines API](https://docs.artosai.com/api-reference/mrt-outlines.md): Manage document outlines with nested sections
- [Get Outline](https://docs.artosai.com/api-reference/outlines/get-outline.md): Get a single outline by ID. Returns the complete outline including metadata and all sections ordered by index. Organization-scoped.
- [Update Outline](https://docs.artosai.com/api-reference/outlines/update-outline.md): Full replacement (PUT) of an outline. All existing sections are deleted and replaced with the provided structure.
- [Templates API](https://docs.artosai.com/api-reference/templates.md): Create and manage templates with nested sections and extraction rules
- [Add Template Section](https://docs.artosai.com/api-reference/templates/add-template-section.md): Add a new section to an existing template.
- [Create Template](https://docs.artosai.com/api-reference/templates/create-template.md): Create a new template with nested sections and rules. Validates inputs and persists to database.
- [Delete Template Section](https://docs.artosai.com/api-reference/templates/delete-template-section.md): Delete a section from a template with optional cascading of child sections. Database CASCADE handles deletion of associated rules.
- [Get Template](https://docs.artosai.com/api-reference/templates/get-template.md): Retrieve a single template by ID with full details including sections and users.
- [List Templates](https://docs.artosai.com/api-reference/templates/list-templates.md): List all templates accessible to the authenticated user. Filtered by organization and user membership, sorted by creation date (newest first).
- [Rename Template Section](https://docs.artosai.com/api-reference/templates/rename-template-section.md): Rename a section in an existing template. Provide the full new name (e.g., '2.1 Efficacy Results').
- [Reorder Template Sections](https://docs.artosai.com/api-reference/templates/reorder-template-sections.md): 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.').
- [Update Rule Styles](https://docs.artosai.com/api-reference/templates/update-rule-styles.md): Update style names, fill color, and/or text color for a template section rule. Styles are returned automatically with the Get Template endpoint.
- [Async Operations](https://docs.artosai.com/concepts/async-operations.md): Understanding asynchronous processing patterns
- [Document Generation](https://docs.artosai.com/concepts/document-generation.md): Understanding the document generation process
- [Template Workflow](https://docs.artosai.com/concepts/mrt-workflow.md): Understanding templates and their structure
- [Organization Model](https://docs.artosai.com/concepts/organization-model.md): Understanding Artos multi-tenancy and organization scoping
- [Template and Document Generation Cookbook](https://docs.artosai.com/cookbooks/template-generation.md): Complete guide to auto-generating templates from examples and generating documents with practical examples
- [Deployment Steps](https://docs.artosai.com/deployment/deployment_steps/deployment_steps.md): High level deployment steps to deploy the Artos platform
- [Global AWS Resources](https://docs.artosai.com/deployment/global_resources/global_aws_resources.md): Shared AWS infrastructure resources for Artos deployment across all environments
- [Bastion Host Module](https://docs.artosai.com/deployment/modules/bastion.md): Secure access to EKS clusters using AWS Systems Manager Session Manager
- [ECR Module](https://docs.artosai.com/deployment/modules/ecr.md): Amazon Elastic Container Registry repositories for Artos application images
- [EKS Module](https://docs.artosai.com/deployment/modules/eks.md): Amazon Elastic Kubernetes Service cluster with managed node groups and Fargate support
- [IAM Module](https://docs.artosai.com/deployment/modules/iam.md): IAM roles and policies for Artos application components using OIDC-based Kubernetes service accounts
- [Monitoring Module](https://docs.artosai.com/deployment/modules/monitoring.md): CloudWatch logging, metrics, alarms, and dashboards for Artos platform observability
- [Networking Module](https://docs.artosai.com/deployment/modules/networking.md): VPC, subnets, security groups, and VPC endpoints for secure private cloud deployment
- [RDS Module](https://docs.artosai.com/deployment/modules/rds.md): Amazon Aurora PostgreSQL database cluster with automated backups, encryption, and high availability
- [S3 Module](https://docs.artosai.com/deployment/modules/s3.md): Amazon S3 storage for documents, files, and static assets with encryption, versioning, and lifecycle management
- [Databases](https://docs.artosai.com/integrations/database.md): Direct database connections for data ingestion and processing via Artos connectors
- [Debugging and Analytics](https://docs.artosai.com/integrations/debugging-analytics.md): Debug workflows, monitor performance, and optimize your Artos implementations with comprehensive analytics
- [Document Management Systems](https://docs.artosai.com/integrations/document-management.md): Integration with enterprise document management platforms.
- [Frontend Customization Components](https://docs.artosai.com/integrations/frontend-customization.md): Embed the Artos platform directly into your applications with complete customization control
- [Model Context Protocol (MCP)](https://docs.artosai.com/integrations/mcp.md): The SDK acts as an MCP client to connect to external MCP servers, providing access to file systems, databases, and APIs through standardized interfaces.
- [Notifications](https://docs.artosai.com/integrations/notifications.md): Configure notifications for Artos services via email, Slack, or Teams
- [Platform Integration](https://docs.artosai.com/integrations/platform-integration.md): Integrate Artos into your existing systems with the 'best of both worlds' approach
- [npm SDK API Reference](https://docs.artosai.com/sdk-reference/npm-api-reference.md): Complete API reference for all functions in the Artos npm SDK (@artosai/sdk).
- [npm SDK Authentication](https://docs.artosai.com/sdk-reference/npm-authentication.md): Configure authentication for the Artos npm SDK using Bearer tokens and the reusable API client.
- [npm SDK Error Handling](https://docs.artosai.com/sdk-reference/npm-error-handling.md): Handle errors and debug issues when using the Artos npm SDK (@artosai/sdk).
- [npm SDK Examples](https://docs.artosai.com/sdk-reference/npm-examples.md): Practical code examples for integrating the Artos npm SDK into your JavaScript, React, and Node.js applications.
- [npm SDK Installation](https://docs.artosai.com/sdk-reference/npm-installation.md): Install and configure the Artos npm SDK (@artosai/sdk) for JavaScript and TypeScript applications.

## OpenAPI Specs

- [openapi-v1](https://docs.artosai.com/api-reference/openapi-v1.json)

## Optional

- [Documentation](https://docs.artosai.com)
- [Website](https://artosai.com)