# DocuWriter.ai - API Docs This documentation space provides comprehensive reference material for integrating with the **DocuWriter.ai REST API**. It covers authentication methods, user information retrieval, generation endpoints for AI tasks (like documentation, comments, and tests), space management (retrieving or modifying documents), handling system events via webhooks, and error specifications. This resource is intended for **developers and integrators** who need to programmatically interact with **DocuWriter.ai** services. The main topics detail how to authenticate using **Bearer Tokens**, how to manage and use Spaces and their documents, and the specific JSON payloads required for all AI generation endpoints. By studying these sections, you can successfully authenticate API calls, perform CRUD operations on documentation **Spaces**, trigger various **AI generation** tasks, and securely receive event notifications through **Webhooks**. * Bearer Token Authentication scheme overview * Endpoints for generating documentation, tests, and diagrams * APIs for managing documentation **Spaces** and documents * Webhook delivery, payload structure, and signature verification * Uniform error codes and response shapes (401/403 handling) Request any document URL with `Accept: text/markdown` to read it as Markdown. ## Bearer Authentication - [Overview](https://docs.docuwriter.ai/docuwriterai-api-docs/bearer-authentication/overview) - [Common auth errors](https://docs.docuwriter.ai/docuwriterai-api-docs/bearer-authentication/common-auth-errors) ## Users API - [POST /api/user](https://docs.docuwriter.ai/docuwriterai-api-docs/users-api/post-apiuser) - [GET /api/user-info](https://docs.docuwriter.ai/docuwriterai-api-docs/users-api/get-apiuser-info) ## Spaces API - [GET /api/spaces/{space}/documents/{spaceMenuItem}](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/get-apispacesspacedocumentsspacemenuitem) - [GET /spaces/{space_id}/documents](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/get-spacesspace-iddocuments) - [POST /api/spaces/{space}/search](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/post-apispacesspacesearch) - [POST /api/spaces/{space}/documents](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/post-apispacesspacedocuments) - [DELETE /api/spaces/{space}/documents/{spaceMenuItem}](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/delete-apispacesspacedocumentsspacemenuitem) - [GET /api/spaces](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/get-apispaces) - [PUT /api/spaces/{space}/documents/{spaceMenuItem}](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/put-apispacesspacedocumentsspacemenuitem) - [POST /api/spaces](https://docs.docuwriter.ai/docuwriterai-api-docs/spaces-api/post-apispaces) ## Webhooks & Security (if applicable) - [Webhook authentication and verification](https://docs.docuwriter.ai/docuwriterai-api-docs/webhooks-security-if-applicable/webhook-authentication-and-verification) - [Event payloads](https://docs.docuwriter.ai/docuwriterai-api-docs/webhooks-security-if-applicable/event-payloads) ## Generations API - [GET /api/generations](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/get-apigenerations) - [POST /api/generate-code-optimization](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/post-apigenerate-code-optimization) - [POST /api/generate-code-documentation](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/post-apigenerate-code-documentation) - [POST /api/generate-swagger-api](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/post-apigenerate-swagger-api) - [GET /api/generations/{id}](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/get-apigenerationsid) - [POST /api/generate-code-comments](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/post-apigenerate-code-comments) - [POST /api/generate-code-tests](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/post-apigenerate-code-tests) - [POST /api/generate-multi-file-documentation](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/post-apigenerate-multi-file-documentation) - [POST /api/generate-uml-diagram](https://docs.docuwriter.ai/docuwriterai-api-docs/generations-api/post-apigenerate-uml-diagram) ## My Generations API - [POST /api/my-generations](https://docs.docuwriter.ai/docuwriterai-api-docs/my-generations-api/post-apimy-generations) ## Repositories API - [GET /api/repositories](https://docs.docuwriter.ai/docuwriterai-api-docs/repositories-api/get-apirepositories)