docuwriter.ai

# DocuWriter.ai

> DocuWriter is an AI-powered platform for creating, updating and managing complete, structured documentation for entire codebases. Teams can connect repositories and generate documentation covering architecture, modules, services, classes, functions, dependencies, APIs, diagrams, READMEs, and other technical components. It supports both individual repositories and larger multi-repository systems.

Use [public source search](https://www.docuwriter.ai/ask?q=your+question) for JSON excerpts and [getting started](https://www.docuwriter.ai/start) for a Markdown guide. Both require no authentication.

Request marketing pages with `Accept: text/markdown` for Cloudflare Markdown. [Full marketing content](https://www.docuwriter.ai/llms-full.txt) includes the selected marketing pages below; technical documentation is linked separately. Blog content is excluded.

## Overview

- [DocuWriter overview](https://www.docuwriter.ai/): How DocuWriter works: generate, manage and maintain complete codebase documentation.
## Platform

- [DocuWriter platform](https://www.docuwriter.ai/platform): The complete DocuWriter workflow for connecting repositories, generating structured codebase documentation, managing it in Spaces, and keeping it current with Autopilot
- [Complete codebase documentation](https://www.docuwriter.ai/automatic-code-documentation-tool): Generate structured documentation for an entire repository.
- [Spaces](https://www.docuwriter.ai/technical-knowledge-management-software): Organize, search, edit and share codebase documentation.
- [Automated Documentation — DocuWriter.ai Autopilot](https://www.docuwriter.ai/automated-documentation): Background agent that watches connected Git repositories, suggests documentation updates with confidence scores, and can auto-apply eligible high-confidence batches with batch reversion.
- [Features Overview](https://www.docuwriter.ai/features): Supporting documentation capabilities, Spaces, Autopilot, MCP and integrations in one platform.
- [Integrations directory](https://www.docuwriter.ai/integrations): Connect repositories, automation, documentation exports, AI assistants, the public API, and notification destinations
## Solutions

- [Enterprise](https://www.docuwriter.ai/enterprise): Enterprise documentation workflows, deployment options, audit logs and team access.
- [DocuWriter for Fintech](https://www.docuwriter.ai/for-fintech): Codebase documentation for financial services teams, onboarding and audit preparation.
- [DocuWriter for Insurance](https://www.docuwriter.ai/for-insurance): Documentation for legacy systems modernization, claims platforms, and policy admin systems.
- [DocuWriter for MSPs](https://www.docuwriter.ai/for-msps): Per-client documentation workspaces, repeatable handover artifacts, and recurring-revenue documentation playbooks for managed service providers.
- [Self-Hosted AI Code Documentation](https://www.docuwriter.ai/self-hosted-ai-code-documentation): Private deployment page for regulated teams that need self-hosted or on-premise AI code documentation with Spaces for storage, search, permissions, retention, and knowledge base management.
- [Solutions](https://www.docuwriter.ai/solutions): Outcome-focused paths for engineering teams adopting DocuWriter across onboarding, handover, modernization, diligence, and compliance workflows
- [Developer Onboarding](https://www.docuwriter.ai/solutions/developer-onboarding): Use complete, connected codebase documentation to help engineers understand architecture, implementation, dependencies, and team workflows faster
## Platform

- [Documentation Quality](https://www.docuwriter.ai/documentation-quality): Plain-language quality scores, page improvements, evaluation history, scoring method, minimum passing scores, and limitations.
- [Resources](https://www.docuwriter.ai/resources): Documentation guides, examples, comparisons, cheat sheets, templates, and practical learning resources
- [Technical Documentation Guide](https://www.docuwriter.ai/technical-documentation): How-to guide on writing technical documentation.
- [Technical Documentation Software](https://www.docuwriter.ai/technical-documentation-software): Buyer's guide to documentation tooling.
- [FinLocker customer story](https://www.docuwriter.ai/customers/finlocker): How FinLocker documented its repositories with DocuWriter.
## Comparisons

- [Compare with Alternatives](https://www.docuwriter.ai/compare): Published comparison of DocuWriter and Compare with Alternatives.
- [DocuWriter vs Archbee](https://www.docuwriter.ai/compare/docuwriter-archbee-alternative): Published comparison of DocuWriter and Archbee.
- [DocuWriter vs CodingFleet](https://www.docuwriter.ai/compare/docuwriter-codingfleet-alternative): Published comparison of DocuWriter and CodingFleet.
- [DocuWriter vs Doxygen](https://www.docuwriter.ai/compare/docuwriter-doxygen-alternative): Published comparison of DocuWriter and Doxygen.
- [DocuWriter vs GitBook](https://www.docuwriter.ai/compare/docuwriter-gitbook-alternative): Published comparison of DocuWriter and GitBook.
- [DocuWriter vs Kapa.ai](https://www.docuwriter.ai/compare/docuwriter-kapa-ai-alternative): Published comparison of DocuWriter and Kapa.ai.
- [DocuWriter vs Mintlify](https://www.docuwriter.ai/compare/docuwriter-mintlify-alternative): Published comparison of DocuWriter and Mintlify.
- [DocuWriter vs Paligo](https://www.docuwriter.ai/compare/docuwriter-paligo-alternative): Published comparison of DocuWriter and Paligo.
- [DocuWriter vs ReadMe.so](https://www.docuwriter.ai/compare/docuwriter-readme-so-alternative): Published comparison of DocuWriter and ReadMe.so.
- [DocuWriter vs Swimm](https://www.docuwriter.ai/compare/docuwriter-swimm-alternative): Published comparison of DocuWriter and Swimm.
## Pricing

- [Pricing Page](https://www.docuwriter.ai/pricing): Live pricing, plan comparison, and FAQ
## Technical documentation: Start here

- [Create your first documentation Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/start-here/create-your-first-documentation-space): This walkthrough takes you from a repository to an editable documentation Space. Use a project you know so you can assess whether the first result describes its behavior correctly.
- [Repositories, Spaces, pages and generations](https://docs.docuwriter.ai/docuwriterai-platform-docs/start-here/repositories-spaces-pages-and-generations): DocuWriter separates source code from the documentation you maintain. Understanding these objects helps you choose the correct action.
- [What is DocuWriter?](https://docs.docuwriter.ai/docuwriterai-platform-docs/start-here/what-is-docuwriter): DocuWriter is an AI-powered platform for creating, updating and managing complete, structured documentation for entire codebases. Teams can connect repositories and generate documentation covering architecture, modules, services, classes, functions, dependencies, APIs, diagrams, READMEs, and other technical components. It supports both individual repositories and larger multi-repository systems.
## Technical documentation: Connect your code

- [Connect a Git repository](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-a-git-repository): Connect a Git provider when you want documentation based on repository code and the option to maintain it as that code changes.
- [Connect Azure DevOps](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-azure-devops): Azure DevOps connections depend on the organization, project and repository permissions granted to DocuWriter. Personal access token setup is available; supported organizational accounts may also use OAuth.
- [Connect Bitbucket](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-bitbucket): Authorize Bitbucket to make repositories available to DocuWriter's repository workflows.
- [Connect GitHub](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-github): Use a GitHub provider connection to select repositories for documentation. The DocuWriter Autopilot GitHub App also supports repository events and pull-request comments for repositories where it is installed.
- [Connect GitLab](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-gitlab): For repositories on GitLab.com, authorize GitLab from Git Connections and then import the repository and branch you want to document.
- [Connect self-hosted GitLab](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-self-hosted-gitlab): Connect your own GitLab instance by registering an OAuth application there and supplying its details in DocuWriter.
- [Document a one-time project ZIP](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/document-a-one-time-project-zip): Upload a project ZIP when you cannot connect a supported Git provider. DocuWriter imports the archive as a source snapshot for Full Tree Documentation.
- [Troubleshoot repository connections](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/troubleshoot-repository-connections): Find the stage that failed before changing settings. Provider authorization, repository selection, code import and documentation generation have different failure causes.
## Technical documentation: Generate documentation

- [Apply writing guidelines and templates](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/apply-writing-guidelines-and-templates): Use Settings → AI preferences to define reusable writing guidance for future generation. You can choose which generators receive it and, as a team owner, enforce it for your team.
- [Choose your documentation audience](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/choose-your-documentation-audience): The audience changes which topics matter and how the documentation explains them. Choose the reader before reviewing the outline.
- [Find and fill documentation gaps](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/find-and-fill-documentation-gaps): Use Update documentation gaps to expand or revise an existing Space using repository source. This workflow lets you review proposed additions and targeted changes before generating them.
- [Generate a per-file reference](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/generate-a-per-file-reference): Codebase Documentation creates a separate document for each selected source file and groups the results into a new Space. Choose it when your goal is file-level reference material.
- [Generate a README](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/generate-a-readme): Use README generation to create a concise entry point for a repository. It complements a full documentation Space by telling readers what the project is and where to begin.
- [Generate release notes from a branch comparison](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/generate-release-notes-from-a-branch-comparison): Use release notes generation to turn a reviewed comparison between two branches into a draft changelog.
- [Use focused generators](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/use-focused-generators): Focused generators produce a particular artifact from the code you supply. They support the broader documentation workflow without replacing a structured Space.
- [Write a focused guide from selected source files](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/write-a-focused-guide-from-selected-source-files): Use Custom prompts when you need a specific explanation or document based on selected files from an imported repository.
- [Generate complete codebase documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/generate-complete-codebase-documentation): Use Full Tree Documentation to produce a structured, multi-page documentation Space. Its outline organizes the project by topics and reader needs, rather than creating a page for every file.
- [Manage saved generations and versions](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/manage-saved-generations-and-versions): Open Generations to find saved outputs from DocuWriter's generators. Use it to review drafts, select a definitive version and reuse outputs in Spaces.
- [Review and customize the outline](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/review-and-customize-the-outline): The documentation outline is the map of the Space you are about to create. Review it for reader usefulness before starting page generation.
- [Troubleshoot documentation generation](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/troubleshoot-documentation-generation): Use the visible run and page statuses to identify whether a problem occurred during source import, outline creation or page generation.
## Technical documentation: Manage and share Spaces

- [Copy pages into AI tools](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/copy-pages-into-ai-tools): Use the page toolbar's Copy page menu to reuse the current documentation in Markdown or open it in a supported external AI tool.
- [Document an endpoint with an API block](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/document-an-endpoint-with-an-api-block): API blocks present an endpoint's method, URL, parameters and response examples inside a documentation page.
- [Edit and review documentation pages](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/edit-and-review-documentation-pages): Open a page in a Space you can edit to maintain its content directly. Manual editing is useful for corrections, context and instructions that should not require a full regeneration.
- [Export and download documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/export-and-download-documentation): Choose an export based on whether you need a portable copy, a document deliverable or a copy in another collaboration system.
- [Organize pages and folders](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/organize-pages-and-folders): A Space collects related documentation in one navigable tree. Use folders for categories and pages for content that answers a specific question or task.
- [Publish a public documentation Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/publish-a-public-documentation-space): Make a Space public when its full documentation collection is intended for readers outside your account or team.
- [Search documentation and ask questions](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/search-documentation-and-ask-questions): Use search to locate an existing page, then read its context. Use an AI question when you need an explanation across the documentation you are allowed to access.
## Technical documentation: Keep documentation current

- [Choose branches, triggers and path filters](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/choose-branches-triggers-and-path-filters): Configure each Autopilot repository link to match the code that should influence a Space.
- [Configure Autopilot notifications](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/configure-autopilot-notifications): Notification settings tell reviewers when a repository link has produced documentation suggestions. They are configured per link, separately from account-level webhook subscriptions and lifecycle email preferences.
- [Configure optional auto-apply](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/configure-optional-auto-apply): Auto-apply can apply eligible Autopilot suggestions without a separate manual approval for each batch. Use it only after reviewing the quality and relevance of suggestions for that repository link.
- [Connect a Space to Autopilot](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/connect-a-space-to-autopilot): Set up Autopilot on the Space that should receive documentation suggestions. Authorizing a Git provider and enabling a Space repository link are separate steps.
- [How Autopilot keeps documentation current](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/how-autopilot-keeps-documentation-current): Autopilot connects a documentation Space to repository changes and prepares suggested documentation updates. It helps maintain an existing documentation set after the initial generation.
- [Review activity and audit history](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/review-activity-and-audit-history): Use a Space's Autopilot Activity view to understand repository processing and documentation changes. Activity is the first place to investigate an expected update that did not appear.
- [Review and apply documentation suggestions](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/review-and-apply-documentation-suggestions): Open the Autopilot inbox to review proposed documentation changes. You can work across Spaces or open the inbox for a specific Space.
- [Troubleshoot missing Autopilot updates](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/troubleshoot-missing-autopilot-updates): Start with the repository link and Activity. A missing suggestion can mean no event arrived, the event was filtered, no documentation update was needed, or processing failed.
## Technical documentation: Integrations and AI assistants

- [Export a Space to Confluence](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/export-a-space-to-confluence): Export a DocuWriter Space to Confluence when your team needs to read the documentation alongside its existing knowledge base. An export publishes a copy to the selected Confluence destination; plan how you will refresh that copy as the source Space changes.
- [Connect an AI assistant to DocuWriter](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-an-ai-assistant-to-docuwriter): MCP setup and reference: Connect your assistant to DocuWriter to search existing documentation, read complete pages, and work with Spaces without copying documents between applications. MCP is the connection protocol; your DocuWriter account remains the source of permissions and available resources.
- [Connect ChatGPT or Codex](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-chatgpt-or-codex): MCP setup and reference: Use the remote DocuWriter MCP server to bring your documentation into ChatGPT or Codex. Authorize the DocuWriter account that owns or can access the Spaces you need.
- [Connect Claude Code](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-claude-code): MCP setup and reference: Connect Claude Code to the remote DocuWriter server to search documentation while working in your repository.
- [Connect Cursor](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-cursor): MCP setup and reference: Add DocuWriter to Cursor so your coding assistant can consult the same documentation your team maintains in Spaces.
- [Connect VS Code](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-vs-code): MCP setup and reference: Connect VS Code’s MCP-enabled assistant to DocuWriter to search and maintain documentation from your editor. Your VS Code account and organization must allow the assistant and MCP servers you intend to use.
- [MCP capabilities and task reference](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/mcp-capabilities-and-task-reference): MCP setup and reference: Use this reference to choose the right operation when working through an external assistant. The connected server supplies its current tool schemas; use those schemas for exact arguments rather than relying on a fixed tool count.
- [Build CI/CD, team, and code-quality workflows](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/n8n/build-cicd-team-and-code-quality-workflows): Build n8n workflows around an explicit input, a DocuWriter operation, a review step, and a destination. The examples below are patterns you configure; connecting the node does not automatically install these automations.
- [Connect n8n and run your first workflow](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/n8n/connect-n8n-and-run-your-first-workflow): Use n8n when you need to connect DocuWriter generation results with repository events, notifications, or another business tool. For keeping an existing documentation Space aligned with repository changes, start by evaluating Autopilot.
- [Prepare an n8n workflow template for sharing](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/n8n/prepare-an-n8n-workflow-template-for-sharing): A useful template lets another team reproduce one clear result without inheriting your account details, credentials, or production destinations. Package a workflow only after you have tested its complete path with sample inputs.
- [Practical Agent workflows](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/practical-agent-workflows): Give the Agent a goal, the relevant Space or repository, and the boundary between drafting and applying. These examples can be adapted to your project; replace names and IDs with resources you can access.
- [Review Agent actions and approvals](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/review-agent-actions-and-approvals): DocuWriter separates answering a question from changing your workspace. The Platform Agent can perform permitted reads directly; changes and generator runs are prepared for your review.
- [Use DocuWriter in Slack](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/use-docuwriter-in-slack): Use the Platform Agent in a private conversation with the DocuWriter Slack app. The linked DocuWriter account controls access to documents and actions; membership in a Slack workspace does not grant DocuWriter permissions.
- [Use the Platform Agent](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/use-the-platform-agent): The Platform Agent helps you find answers in your documentation and perform supported DocuWriter tasks from a conversation. Use it when you need an explanation grounded in your Spaces, help finding the right product workflow, or a reviewable change to existing content.
- [Receive outgoing DocuWriter webhooks](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/receive-outgoing-docuwriter-webhooks): Outgoing webhooks notify your service when selected DocuWriter events occur. Use them for completion notifications, integration workflows, or a downstream index. They are separate from the Git-provider webhooks used by Autopilot.
## Technical documentation: Account and billing

- [Get support and report a documentation problem](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/get-support-and-report-a-documentation-problem): Contact support@docuwriter.ai or use the in-app support flow when you need help with an account-specific issue.
- [Invite teammates and manage access](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/invite-teammates-and-manage-access): Teams let colleagues work with shared documentation using the permissions assigned to them. The team owner's plan and usage pool govern the team's supported features.
- [Manage your account and subscription](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/manage-your-account-and-subscription): Use your Profile page for account, security and subscription settings. Account owners manage billing; team members use the team's access and should contact the owner for subscription changes.
- [Understand credits and usage](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/understand-credits-and-usage): Credits measure eligible AI generation usage. Check the account's current Usage and Billing screens for its available balance, billing period and included features.
## Technical documentation: API reference

- [Manage Autopilot repository links](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/autopilot/manage-autopilot-repository-links): Link a Space to a repository so Autopilot can propose documentation changes. The account must manage the Space; mutations require Enterprise entitlement and the relevant provider connection/permissions. Endpoints: GET /api/autopilot/spaces/{space}/links, POST /api/autopilot/spaces/{space}/links, PATCH /api/autopilot/spaces/{space}/links/{link}, DELETE /api/autopilot/spaces/{space}/links/{link}, POST /api/autopilot/spaces/{space}/links/{link}/enable, POST /api/autopilot/spaces/{space}/links/{link}/disable, GET /api/autopilot/spaces/{space}/providers/{provider}/repositories.
- [Read and review Autopilot suggestions](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/autopilot/read-and-review-autopilot-suggestions): Use these endpoints to integrate a review queue for proposed documentation changes. They operate on suggestions for Spaces the account can manage. Endpoints: GET /api/autopilot/suggestions, GET /api/autopilot/suggestions/counts, POST /api/autopilot/suggestions/{id}/apply, POST /api/autopilot/suggestions/{id}/discard, POST /api/autopilot/suggestions/{id}/snooze, POST /api/autopilot/suggestions/bulk.
- [Convert code between languages](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/convert-code-between-languages): Generate a translation of supplied source code into another language or framework. Endpoints: POST /api/generate-language-conversion.
- [Generate a UML diagram](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-a-uml-diagram): Describe code structure or behavior using a generated UML diagram. Endpoints: POST /api/generate-uml-diagram.
- [Generate code comments](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-comments): Add documentation comments to supplied source code. Endpoints: POST /api/generate-code-comments.
- [Generate code documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-documentation): Generate Markdown documentation for a supplied source file. Endpoints: POST /api/generate-code-documentation.
- [Generate code optimization](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-optimization): Request improvements to supplied code. Endpoints: POST /api/generate-code-optimization.
- [Generate code tests](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-tests): Generate test code for a supplied source file. Endpoints: POST /api/generate-code-tests.
- [Generate multi-file documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-multi-file-documentation): Generate one documentation output from multiple supplied source files. Endpoints: POST /api/generate-multi-file-documentation.
- [Generate Swagger / OpenAPI documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-swagger-openapi-documentation): Generate an API-description document from supplied source code. Endpoints: POST /api/generate-swagger-api.
- [Get a generation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/get-a-generation): Retrieve a saved generation by its numeric database ID. Endpoints: GET /api/generations/{id}.
- [List and filter my generations](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/list-and-filter-my-generations): Retrieve a paginated generation collection including numeric IDs and Markdown output. Endpoints: POST /api/my-generations.
- [List generations](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/list-generations): Read saved generations newest first. Endpoints: GET /api/generations.
- [List connected repositories](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/repositories/list-connected-repositories): Discover usable connected repositories associated with your account. Endpoints: GET /api/repositories.
- [Search a Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/search/search-a-space): Find documentation using semantic search within one Space. Endpoints: POST /api/spaces/{space}/search.
- [Search across accessible Spaces](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/search/search-across-accessible-spaces): Search documentation across the Spaces accessible to your account. Endpoints: POST /api/search.
- [Create a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/create-a-document): Create a page from Markdown, optionally under a folder path. Endpoints: POST /api/spaces/{space}/documents.
- [Create a Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/create-a-space): Create a container for documentation. New Spaces are private unless you explicitly publish them. Endpoints: POST /api/spaces.
- [Delete a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/delete-a-document): Delete the selected Space item. Read and preserve any content you need before calling this endpoint. Endpoints: DELETE /api/spaces/{space}/documents/{spaceMenuItem}.
- [Export documents and Spaces](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/export-documents-and-spaces): Download a page as Markdown or PDF, or a whole Space as a single PDF. These routes use numeric Space and menu-item IDs. Endpoints: POST /api/spaces/{space}/menu-items/{spaceMenuItem}/export/markdown, POST /api/spaces/{space}/menu-items/{spaceMenuItem}/export/pdf, POST /api/spaces/{space}/export/pdf.
- [List documents in a Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/list-documents-in-a-space): Retrieve a Space hierarchy before reading or changing individual pages. Endpoints: GET /api/spaces/{space}/documents.
- [List Spaces](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/list-spaces): Find the numeric Space ID to use in document and search requests. Endpoints: GET /api/spaces.
- [Read a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/read-a-document): Read one document as Markdown and obtain its metadata. Endpoints: GET /api/spaces/{space}/documents/{spaceMenuItem}.
- [Update a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/update-a-document): Replace a page body, rename an item, or move it to another folder without changing its numeric ID. Endpoints: PUT /api/spaces/{space}/documents/{spaceMenuItem}.
- [Bearer authentication and token management](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/bearer-authentication-and-token-management): Every endpoint in this API reference requires an account API token. Publicly viewable documentation does not make the document-management API anonymous.
- [Errors, limits and retry behavior](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/errors-limits-and-retry-behavior): Inspect both the HTTP status and JSON response. Most controller errors use success: false and message; validation failures may also contain an errors object keyed by request field. Laravel validation responses and Autopilot resources do not always include success.
- [Get account and credit information](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/get-account-and-credit-information): Read account identity and current credit/subscription indicators. Endpoints: GET /api/user-info.
- [Get the authenticated user](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/get-the-authenticated-user): Check which account your API token authenticates. Endpoints: POST /api/user.
- [Public API quickstart](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/public-api-quickstart): Build integrations that generate documentation, manage documents in Spaces, retrieve existing work, search documentation, and respond to webhook events.
- [Manage webhook subscriptions](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/webhooks/manage-webhook-subscriptions): Receive notifications at your own HTTPS endpoint after generation or Autopilot events. Use the account Bearer token for subscription management; outgoing deliveries use a separate webhook signing secret. Endpoints: GET /api/webhooks, POST /api/webhooks, GET /api/webhooks/{id}, PUT /api/webhooks/{id}, DELETE /api/webhooks/{id}, GET /api/webhooks/events/available, POST /api/webhooks/{id}/test.
- [Verify webhook signatures](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/webhooks/verify-webhook-signatures): Verify every incoming webhook before processing its payload. The API token used to manage subscriptions is not the signing secret: use the subscription’s secret.
- [Webhook event payloads and delivery](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/webhooks/webhook-event-payloads-and-delivery): All subscription deliveries share this envelope: