# Autype

## Docs

- [Authentication](https://docs.autype.com/api-reference/authentication.md): How to authenticate your API requests
- [Add PDF watermark](https://docs.autype.com/api-reference/developer-api/add-pdf-watermark.md): Add a text watermark to all or specific pages of a PDF.
- [Classify document](https://docs.autype.com/api-reference/developer-api/classify-document.md): Classify a document into one of the provided categories using AI. The AI reads the first 3 pages of the document and picks the best matching category. Supports PDF, DOCX, ODT, and Markdown files. Cost: 4 credits per request.
- [Compress PDF](https://docs.autype.com/api-reference/developer-api/compress-pdf.md): Compress a PDF to reduce file size. Choose from three compression levels: low (light), medium (balanced), high (maximum).
- [Convert DOCX to PDF](https://docs.autype.com/api-reference/developer-api/convert-docx-to-pdf.md): Convert a DOCX file to PDF or other formats like ODT.
- [Convert ODT to PDF](https://docs.autype.com/api-reference/developer-api/convert-odt-to-pdf.md): Convert an ODT file to PDF or other formats like DOCX.
- [Create bulk render job from file](https://docs.autype.com/api-reference/developer-api/create-bulk-render-job-from-file.md): Create a bulk render job by uploading a CSV, Excel, or JSON file with variable data.
- [Create bulk render job from JSON](https://docs.autype.com/api-reference/developer-api/create-bulk-render-job-from-json.md): Create a bulk render job with an array of variable sets. Each item generates one document.
- [Create document](https://docs.autype.com/api-reference/developer-api/create-document.md): Create a new document in a project. The document is attributed to the API key creator. Optionally provide initial document content following the Autype document JSON schema. If no content is provided, a default document with the title as heading is created.
- [Create project](https://docs.autype.com/api-reference/developer-api/create-project.md): Create a new project in the organization. Projects created via the API are always PUBLIC (visible to all org members).
- [Delete a file](https://docs.autype.com/api-reference/developer-api/delete-a-file.md): Delete a tool file. The file is removed from storage immediately.
- [Delete a temporary image](https://docs.autype.com/api-reference/developer-api/delete-a-temporary-image.md): Delete a temporary image before it expires.
- [Download a file](https://docs.autype.com/api-reference/developer-api/download-a-file.md): Download a tool file by ID. Returns the raw file stream.
- [Download bulk render output ZIP](https://docs.autype.com/api-reference/developer-api/download-bulk-render-output-zip.md): Download the bulk render output as a ZIP file. Supports two authentication methods: (1) API key via X-API-Key header, or (2) signed download token via ?token= query parameter. The token is included in the downloadUrl returned by the bulk job status endpoint.
- [Download render output file](https://docs.autype.com/api-reference/developer-api/download-render-output-file.md): Download the rendered document file. Supports two authentication methods: (1) API key via X-API-Key header, or (2) signed download token via ?token= query parameter. The token is included in the downloadUrl returned by the job status endpoint.
- [Extract structured data](https://docs.autype.com/api-reference/developer-api/extract-structured-data.md): Extract structured data from a document based on a user-defined field schema. Define field names, types (string, number, boolean, date, array), and optional descriptions. The AI reads the document and returns a JSON object with the extracted values. For PDF files, you can optionally specify which pa…
- [Fill PDF form fields](https://docs.autype.com/api-reference/developer-api/fill-pdf-form-fields.md): Fill form fields in a PDF with provided values. Supports text fields, checkboxes, dropdowns, and radio groups. Optionally flatten fields to make them non-editable.
- [Generate document filename](https://docs.autype.com/api-reference/developer-api/generate-document-filename.md): Generate a structured filename for a document based on a naming schema with placeholders (e.g. "invoice-{invoiceNr}-{dateCreated}"). The AI extracts text from the document and uses an LLM to fill in the placeholder values. Cost: 4 credits per request.
- [Get bulk render job status](https://docs.autype.com/api-reference/developer-api/get-bulk-render-job-status.md): Poll for bulk render job status. When completed, includes a download URL for the ZIP file.
- [Get document](https://docs.autype.com/api-reference/developer-api/get-document.md): Get a document by ID including its latest content (JSON snapshot). Only documents in PUBLIC projects belonging to the organization are accessible.
- [Get document variables](https://docs.autype.com/api-reference/developer-api/get-document-variables.md): Get the variable definitions for a document. Use this to understand what variables are required for bulk rendering.
- [Get file details](https://docs.autype.com/api-reference/developer-api/get-file-details.md): Get metadata for a specific tool file.
- [Get job status](https://docs.autype.com/api-reference/developer-api/get-job-status.md): Get the current status of a tool job. Poll this endpoint until status is COMPLETED or FAILED.
- [Get PDF form fields](https://docs.autype.com/api-reference/developer-api/get-pdf-form-fields.md): Extract form field names, types, and current values from a PDF. Result is returned in the job metadata — no output file is created.
- [Get PDF metadata](https://docs.autype.com/api-reference/developer-api/get-pdf-metadata.md): Extract metadata from a PDF (page count, title, author, etc.). Result is returned in the job metadata field — no output file is created.
- [Get render job status](https://docs.autype.com/api-reference/developer-api/get-render-job-status.md): Poll for render job status. When completed, includes a download URL.
- [Keep or remove PDF pages](https://docs.autype.com/api-reference/developer-api/keep-or-remove-pdf-pages.md): Keep or remove specific pages from a PDF. Use page specs like "1", "2-5", "3-".
- [Lens OCR](https://docs.autype.com/api-reference/developer-api/lens-ocr.md): Extract text from a document using AI. Supports PDF, DOCX, ODT, and Markdown files. Output formats: "md" (raw standard markdown), "mdd" (Autype extended markdown with document settings and defaults), "json" (full Autype document JSON with sections). For PDF files with "md" format you can optionally…
- [List documents](https://docs.autype.com/api-reference/developer-api/list-documents.md): List all documents for the organization. Optionally filter by project ID. Results are paginated and sorted by last updated date (newest first).
- [List files](https://docs.autype.com/api-reference/developer-api/list-files.md): List all non-expired tool files for the organization.
- [List jobs](https://docs.autype.com/api-reference/developer-api/list-jobs.md): List tool jobs for the organization, ordered by creation date (newest first).
- [List projects](https://docs.autype.com/api-reference/developer-api/list-projects.md): List all projects for the organization. Results are paginated and sorted by creation date (oldest first).
- [List render jobs](https://docs.autype.com/api-reference/developer-api/list-render-jobs.md): List all render jobs for the organization. Jobs are retained for 1 hour after completion (DOCX/ODT) or until cleanup (PDF keeps last 5 per document).
- [List temporary images](https://docs.autype.com/api-reference/developer-api/list-temporary-images.md): List all non-expired temporary images for the organization.
- [Merge PDFs](https://docs.autype.com/api-reference/developer-api/merge-pdfs.md): Merge 2–20 PDF files into a single PDF. Pages are concatenated in the order of the provided file IDs.
- [PDF to image](https://docs.autype.com/api-reference/developer-api/pdf-to-image.md): Convert PDF pages to images (PNG or JPEG). Single-page output is a direct image file, multi-page output is a ZIP archive.
- [Protect PDF](https://docs.autype.com/api-reference/developer-api/protect-pdf.md): Encrypt a PDF with password protection. Provide a user password (to open) and/or an owner password (to edit). At least one is required.
- [Render a document from Extended Markdown (temporary)](https://docs.autype.com/api-reference/developer-api/render-a-document-from-extended-markdown-temporary.md): Submit Extended Markdown content for rendering to PDF, DOCX, or ODT. This is a **temporary render** — the Markdown is not persisted and the render output expires. No document is created in your Autype workspace. The Markdown is converted to document sections automatically. Supports all Autype extend…
- [Render a document from JSON (temporary)](https://docs.autype.com/api-reference/developer-api/render-a-document-from-json-temporary.md): Submit a document JSON for rendering to PDF, DOCX, or ODT. This is a **temporary render** — the document JSON is not persisted and the render output expires. No document is created in your Autype workspace. Use POST /render/document/{documentId} to render a persistent document instead. Returns a job…
- [Render a persistent document](https://docs.autype.com/api-reference/developer-api/render-a-persistent-document.md): Render a pre-existing document from your Autype workspace by its ID. The document must belong to a PUBLIC project in your organization. Uses the latest saved document content (snapshot). You can optionally override variables or output format. Images stored in the document are resolved automatically.…
- [Replace placeholders in DOCX/ODT](https://docs.autype.com/api-reference/developer-api/replace-placeholders-in-docxodt.md): Replace {{placeholder}} tags in a DOCX or ODT document with provided values. Supports text, images, lists, and tables. Output format is configurable.
- [Rotate PDF pages](https://docs.autype.com/api-reference/developer-api/rotate-pdf-pages.md): Rotate specific pages of a PDF by 90, 180, or 270 degrees.
- [Split PDF](https://docs.autype.com/api-reference/developer-api/split-pdf.md): Split a PDF into multiple parts by page ranges. Each range produces a separate PDF. Output is a ZIP file.
- [Unlock PDF](https://docs.autype.com/api-reference/developer-api/unlock-pdf.md): Remove password protection from a PDF. Provide the password used to protect it.
- [Upload a file](https://docs.autype.com/api-reference/developer-api/upload-a-file.md): Upload a file (PDF, DOCX, ODT, PNG, or JPEG, max 50 MB) for use with tool actions. Files expire after 60 minutes.
- [Upload a temporary image](https://docs.autype.com/api-reference/developer-api/upload-a-temporary-image.md): Upload a temporary image for use in ad-hoc renders (POST /render, POST /render/markdown). Images expire after 24 hours. Use the returned refPath (e.g. `/temp-image/{id}`) in your document JSON image src. **Not suitable for persistent documents** — persistent documents use permanent images uploaded v…
- [Developer API](https://docs.autype.com/api-reference/introduction.md): Programmatic access to Autype's document generation capabilities
- [Abbreviations](https://docs.autype.com/api-reference/json-syntax/abbreviations.md): Define abbreviation short forms and generate automatic abbreviation lists
- [Citations](https://docs.autype.com/api-reference/json-syntax/citations.md): CSL-JSON citations and automatic bibliography generation
- [Defaults](https://docs.autype.com/api-reference/json-syntax/defaults.md): Global styling defaults: fonts, colors, spacing, element styles, header/footer, and more
- [Document JSON Overview](https://docs.autype.com/api-reference/json-syntax/overview.md): Top-level structure of the Autype document JSON used for rendering
- [Block Quotes](https://docs.autype.com/api-reference/json-syntax/sections/blockquotes.md): Styled block quote containers with borders, backgrounds, and typography options
- [Indices](https://docs.autype.com/api-reference/json-syntax/sections/indices.md): Table of contents, list of figures, list of tables, list of code listings, and other auto-generated indices
- [Layout](https://docs.autype.com/api-reference/json-syntax/sections/layout.md): Section types, columns, page breaks, and spacers
- [Lists](https://docs.autype.com/api-reference/json-syntax/sections/lists.md): Ordered and unordered lists with nested items
- [Media & Code](https://docs.autype.com/api-reference/json-syntax/sections/media.md): Images, charts, QR codes, code blocks, and math equations
- [Tables](https://docs.autype.com/api-reference/json-syntax/sections/tables.md): Table elements with headers, rows, cell formatting, captions, and variable data binding
- [Text Elements](https://docs.autype.com/api-reference/json-syntax/sections/text-elements.md): Headings, paragraphs, and inline text formatting
- [Variables](https://docs.autype.com/api-reference/json-syntax/variables.md): Dynamic content substitution with text, number, image, list, and table variables
- [Rate Limits & Quotas](https://docs.autype.com/api-reference/rate-limits.md): Usage limits, quotas, credit costs, and data retention policies
- [HTML to PDF](https://docs.autype.com/api-reference/tools/html-to-pdf.md): Convert any HTML file into a high-quality PDF with full control over page layout, margins, headers, and footers
- [Autype Lens](https://docs.autype.com/api-reference/tools/lens.md): AI-powered document understanding — OCR, classification, filename generation, and structured data extraction
- [PDF Form Fields & Fill Form](https://docs.autype.com/api-reference/tools/pdf-forms.md): Extract form field metadata from a PDF and fill form fields programmatically
- [DOCX/ODT Placeholder Replacement](https://docs.autype.com/api-reference/tools/placeholder-replacement.md): Replace {{placeholder}} tags in DOCX and ODT documents with text, images, lists, and tables
- [Webhooks & Job Status](https://docs.autype.com/api-reference/webhooks.md): Real-time notifications via webhooks or polling for job completion
- [Make.com](https://docs.autype.com/automation/integrations/make/overview.md): Connect Autype to Make.com for automated document generation
- [Claude Code (CLI)](https://docs.autype.com/automation/integrations/mcp/claude-code.md): Connect Autype to Claude's command-line interface
- [Claude Desktop](https://docs.autype.com/automation/integrations/mcp/claude-desktop.md): Connect Autype to Claude Desktop app
- [Cursor](https://docs.autype.com/automation/integrations/mcp/cursor.md): Connect Autype to Cursor AI-powered code editor
- [MCP Inspector](https://docs.autype.com/automation/integrations/mcp/inspector.md): Test and debug the Autype MCP server with the official inspector tool
- [MCP Server Overview](https://docs.autype.com/automation/integrations/mcp/overview.md): Connect any MCP-compatible AI agent or IDE to Autype
- [VS Code (GitHub Copilot)](https://docs.autype.com/automation/integrations/mcp/vscode.md): Connect Autype to Visual Studio Code with GitHub Copilot
- [Windsurf](https://docs.autype.com/automation/integrations/mcp/windsurf.md): Connect Autype to Windsurf IDE with Cascade
- [n8n](https://docs.autype.com/automation/integrations/n8n/overview.md): Connect Autype to n8n for self-hosted document automation workflows
- [VS Code Extension](https://docs.autype.com/automation/integrations/vscode/overview.md): Write professional documents in Markdown and export as PDF, DOCX & ODT — directly from VS Code
- [Abbreviations Schema](https://docs.autype.com/automation/llm-resources/abbreviations-schema.md): JSON Schema for abbreviation definitions.
- [Citations Schema](https://docs.autype.com/automation/llm-resources/citations-schema.md): JSON Schema for bibliography entries in CSL-JSON format.
- [Defaults Schema](https://docs.autype.com/automation/llm-resources/defaults-schema.md): JSON Schema for global document styling defaults — fonts, colors, spacing, header/footer, citation style.
- [Complete Document Schema](https://docs.autype.com/automation/llm-resources/document-schema.md): Full JSON Schema for Autype documents — all element types, sections, styling, variables, citations, and abbreviations.
- [Document Settings Schema](https://docs.autype.com/automation/llm-resources/document-settings-schema.md): JSON Schema for page settings — output format, page size, margins, orientation, and metadata.
- [Markdown Syntax Reference](https://docs.autype.com/automation/llm-resources/markdown-syntax.md): Compact reference for Autype's extended Markdown syntax — all directives, attributes, and examples for LLMs.
- [LLM Resources](https://docs.autype.com/automation/llm-resources/overview.md): Machine-readable schemas and references for LLMs and AI agents to work with Autype documents.
- [Sections & Elements Schema](https://docs.autype.com/automation/llm-resources/sections-schema.md): JSON Schema for all document section types and content elements.
- [Variables Schema](https://docs.autype.com/automation/llm-resources/variables-schema.md): JSON Schema for template variable definitions — text, number, image, list, and table types.
- [Integrations](https://docs.autype.com/automation/overview.md): Connect Autype to your AI agents, automation platforms, and developer workflows
- [AI integrations](https://docs.autype.com/getting-started/concepts/ai.md): Autype's AI assistant writes, formats, and generates content directly in the editor. The underlying JSON schema makes documents fully accessible to LLMs.
- [Collaboration and organizations](https://docs.autype.com/getting-started/concepts/collaboration.md): Real-time co-editing with live cursors, line-anchored comments with threaded discussions, team management with roles, and offline support — all built into Autype.
- [Features](https://docs.autype.com/getting-started/concepts/features.md): Autype's full feature set: Markdown syntax, citations, automatic indices, reusable styles, page layouts, charts, variables, collaboration, automation, and more.
- [What is Autype?](https://docs.autype.com/getting-started/concepts/overview.md): Autype is a document editor that supports Markdown syntax with extensions for professional document creation. AI-native, automation-ready, and securely hosted in the EU.
- [Projects](https://docs.autype.com/getting-started/concepts/projects.md): Projects are the central data structure in Autype — they contain documents, variables, versions, and all associated content.
- [Syntax Cheatsheet](https://docs.autype.com/getting-started/concepts/syntax-cheatsheet.md): Quick reference for all Autype markup syntax — standard Markdown and extended features at a glance.
- [Editor](https://docs.autype.com/getting-started/editor/editor-overview.md): The Autype document editor — write Markdown, preview in real time, and use the sidebar panels for variables, styles, citations, and more.
- [Using Autype](https://docs.autype.com/getting-started/editor/overview.md): From sign-up to document export — everything you need to know about the Autype application.
- [Settings](https://docs.autype.com/getting-started/editor/settings.md): Manage your profile, appearance, editor preferences, team members, and API keys from the settings modal.
- [Abbreviations Panel](https://docs.autype.com/getting-started/editor/sidebar-abbreviations.md): Define abbreviation expansions that are used throughout your document and appear in the List of Abbreviations.
- [Bulk Generation Panel](https://docs.autype.com/getting-started/editor/sidebar-bulk.md): Generate multiple personalized documents from a single template by uploading a CSV, Excel, or JSON data file.
- [AI Assistant Panel](https://docs.autype.com/getting-started/editor/sidebar-chat.md): Chat with the AI assistant to edit, rewrite, or extend your document content — directly from the sidebar.
- [Citations Panel](https://docs.autype.com/getting-started/editor/sidebar-citations.md): Import and manage bibliography sources — add citations from BibTeX, DOI, or manually, and insert them into your document.
- [Comments Panel](https://docs.autype.com/getting-started/editor/sidebar-comments.md): Add inline comments to your document, reply to threads, and collaborate with your team.
- [Documents Panel](https://docs.autype.com/getting-started/editor/sidebar-documents.md): Quickly access your most recently edited documents from the sidebar — without leaving the editor.
- [Version History Panel](https://docs.autype.com/getting-started/editor/sidebar-history.md): View, compare, and restore previous versions of your document — with automatic and manual snapshots.
- [Images Panel](https://docs.autype.com/getting-started/editor/sidebar-images.md): Upload, manage, and insert images into your document from the sidebar panel.
- [Knowledge Base Panel](https://docs.autype.com/getting-started/editor/sidebar-knowledge.md): Upload reference documents and URLs to give the AI assistant context about your topic.
- [Styles Panel](https://docs.autype.com/getting-started/editor/sidebar-styles.md): Create, manage, and apply document style presets — control fonts, colors, spacing, headers, footers, and more.
- [Variables Panel](https://docs.autype.com/getting-started/editor/sidebar-variables.md): Define and manage document variables — text, numbers, images, lists, and tables — for reusable content, bulk generation, and API automation.
- [Signup & Login](https://docs.autype.com/getting-started/editor/signup-login.md): Create your Autype account or sign in — with email/password or OAuth providers.
- [Workspace](https://docs.autype.com/getting-started/editor/workspace.md): Your central hub — create documents with AI, manage projects, switch organizations, and navigate your documents.
- [Autype Documentation](https://docs.autype.com/getting-started/index.md): Stop fighting your document tools. Autype lets you write in Markdown, export pixel-perfect PDFs, DOCX, and ODT — and automate the entire process via API. AI-native. EU-hosted. Built for scale.
- [Pricing and credits](https://docs.autype.com/getting-started/pricing.md): Autype uses a credit-based system for AI features and API rendering. Choose a plan that fits your usage, and buy additional credits anytime.
- [Quickstart](https://docs.autype.com/getting-started/quickstart.md): Create your first Autype document in under 5 minutes — from sign-up to PDF export.
- [Abbreviations](https://docs.autype.com/markup-reference/abbreviations.md): Define abbreviations inline with ~ABK~ syntax and generate an automatic list of abbreviations.
- [Block Quotes](https://docs.autype.com/markup-reference/blockquotes.md): Styled block quotes with optional properties for borders, backgrounds, alignment, and typography.
- [Charts](https://docs.autype.com/markup-reference/charts.md): Create bar, line, pie, doughnut, radar, polar area, scatter, and bubble charts with the chart directive.
- [Citations & Bibliography](https://docs.autype.com/markup-reference/citations.md): Inline citations with page, chapter, and volume locators, author suppression, narrative mode, and automatic bibliography generation.
- [Code Blocks](https://docs.autype.com/markup-reference/code-blocks.md): Syntax-highlighted code blocks with optional render-as-image, custom background colors, alignment, and spacing.
- [Diagrams](https://docs.autype.com/markup-reference/diagrams.md): Render diagrams from text using Mermaid, PlantUML, GraphViz, and 15+ other diagram languages.
- [Headings & Paragraphs](https://docs.autype.com/markup-reference/headings-paragraphs.md): Headings (h1–h6), paragraphs, and the text2 variant — with standard Markdown and extended HTML syntax for full styling control.
- [Images](https://docs.autype.com/markup-reference/images.md): Embed images with sizing, alignment, captions, and anchors — using standard Markdown or the image directive.
- [Automatic Indices](https://docs.autype.com/markup-reference/indices.md): Generate a table of contents, list of figures, list of tables, list of code listings, and list of abbreviations automatically from your document content.
- [Inline Formatting](https://docs.autype.com/markup-reference/inline-formatting.md): Bold, italic, underline, strikethrough, highlight, inline code, links, and line breaks — all inline formatting options in Autype.
- [Lists](https://docs.autype.com/markup-reference/lists.md): Ordered and unordered lists with nesting and inline formatting support.
- [Math (LaTeX)](https://docs.autype.com/markup-reference/math.md): Block math expressions with LaTeX syntax, alignment options, and render-as-image for perfect PDF output.
- [Markup Reference](https://docs.autype.com/markup-reference/overview.md): Complete reference for Autype's extended Markdown syntax — standard Markdown plus powerful extensions for professional documents.
- [Page Layout](https://docs.autype.com/markup-reference/page-layout.md): Control page layout with page sections, columns layout, spacers, page breaks, and orientation changes for professional document output.
- [QR Codes](https://docs.autype.com/markup-reference/qr-codes.md): Generate URL, WiFi, and vCard QR codes directly in your documents with customizable size and error correction.
- [References & Anchors](https://docs.autype.com/markup-reference/references.md): Cross-reference headings, images, charts, and tables with automatic numbering — using anchors and three display modes.
- [Tables](https://docs.autype.com/markup-reference/tables.md): Standard Markdown tables and the extended table directive with 20+ styling attributes, captions, anchors, invisible borders, and images in cells.
- [Variables](https://docs.autype.com/markup-reference/variables.md): Inline and block-level variables, built-in variables for headers/footers, and advanced date formatting with offsets and timezones.

## OpenAPI Specs

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

## Optional

- [App](https://app.autype.com)
- [API Status](https://status.autype.com/status/autype)