Public API quickstart

Build integrations that generate documentation, manage documents in Spaces, retrieve existing work, search documentation, and respond to webhook events.

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.

Make your first request

  1. Sign in to DocuWriter and open Settings → API Tokens.
  2. Create a token and store it as DOCUWRITER_API_TOKEN in your application's secret storage.
  3. Request your account details:
curl --request GET "https://app.docuwriter.ai/api/user-info" \
  --header "Authorization: Bearer $DOCUWRITER_API_TOKEN" \
  --header "Accept: application/json"

A successful request returns HTTP 200 with success: true and a data object containing your account ID, name, email, remaining credits and subscription information. A 401 means the token was not accepted; consult Authentication.

Build a documentation workflow

Use List Spaces, then List documents and Read a document. To publish your own Markdown into a Space, create a document. To generate content from supplied source files, start with Generate code documentation or Multi-file documentation.

The REST generators documented here work with source code supplied in the request. They do not initiate the repository-wide documentation-tree workflow. Use the product's repository workflow for that task.

Conventions

The base URL is https://app.docuwriter.ai/api. Send Accept: application/json; for JSON bodies also send Content-Type: application/json. Most endpoints return success and data, but resource collections, Autopilot and downloads have their own shapes documented per endpoint. Numeric Space, document and generation IDs are distinct from public slugs and UUIDs. See Errors and retries before adding automatic retries.

Updated