DocuWriter.ai REST API .well-known API

REST API for generating code documentation, tests, comments, UML diagrams, Swagger/OpenAPI specs, and managing DocuWriter.ai Spaces.

Operations 11

POST /generate-code-documentation Generate code documentation #
POST /generate-multi-file-documentation Generate documentation from multiple files #
POST /generate-swagger-api Generate Swagger/OpenAPI documentation #
POST /generate-uml-diagram Generate UML diagrams #
GET /spaces List Spaces #
POST /spaces Create a Space #
GET /spaces/{space}/documents List Space documents #
POST /spaces/{space}/documents Create a Space document #
POST /spaces/{space}/search Search documents in a Space #
GET /generations List generations #
GET /repositories List connected repositories #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/docuwriter-ai:docuwriter-ai-rest-api-well-known-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

docuwriter-ai-well-known-openapi.json Raw ↑
{
  "openapi": "3.1.0",
  "info": {
    "title": "DocuWriter.ai REST API",
    "version": "1.0.0",
    "description": "REST API for generating code documentation, tests, comments, UML diagrams, Swagger/OpenAPI specs, and managing DocuWriter.ai Spaces.",
    "termsOfService": "https://www.docuwriter.ai/terms"
  },
  "servers": [
    {
      "url": "https://app.docuwriter.ai/api"
    }
  ],
  "externalDocs": {
    "description": "DocuWriter.ai API documentation",
    "url": "https://docs.docuwriter.ai/docuwriterai-api-docs/api-reference/start-with-the-api/public-api-quickstart"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "GenerationRequest": {
        "type": "object",
        "additionalProperties": true
      },
      "GenerationResponse": {
        "type": "object",
        "additionalProperties": true
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/generate-code-documentation": {
      "post": {
        "summary": "Generate code documentation",
        "operationId": "generateCodeDocumentation",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GenerationRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Generated documentation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenerationResponse"
                }
              }
            }
          }
        }
      }
    },
    "/generate-multi-file-documentation": {
      "post": {
        "summary": "Generate documentation from multiple files",
        "operationId": "generateMultiFileDocumentation",
        "responses": {
          "200": {
            "description": "Generated documentation"
          }
        }
      }
    },
    "/generate-swagger-api": {
      "post": {
        "summary": "Generate Swagger/OpenAPI documentation",
        "operationId": "generateSwaggerApi",
        "responses": {
          "200": {
            "description": "Generated API specification"
          }
        }
      }
    },
    "/generate-uml-diagram": {
      "post": {
        "summary": "Generate UML diagrams",
        "operationId": "generateUmlDiagram",
        "responses": {
          "200": {
            "description": "Generated UML diagram"
          }
        }
      }
    },
    "/spaces": {
      "get": {
        "summary": "List Spaces",
        "operationId": "listSpaces",
        "responses": {
          "200": {
            "description": "Spaces list"
          }
        }
      },
      "post": {
        "summary": "Create a Space",
        "operationId": "createSpace",
        "responses": {
          "200": {
            "description": "Created Space"
          }
        }
      }
    },
    "/spaces/{space}/documents": {
      "get": {
        "summary": "List Space documents",
        "operationId": "listSpaceDocuments",
        "parameters": [
          {
            "name": "space",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Document list"
          }
        }
      },
      "post": {
        "summary": "Create a Space document",
        "operationId": "createSpaceDocument",
        "parameters": [
          {
            "name": "space",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Created document"
          }
        }
      }
    },
    "/spaces/{space}/search": {
      "post": {
        "summary": "Search documents in a Space",
        "operationId": "searchSpaceDocuments",
        "parameters": [
          {
            "name": "space",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results"
          }
        }
      }
    },
    "/generations": {
      "get": {
        "summary": "List generations",
        "operationId": "listGenerations",
        "responses": {
          "200": {
            "description": "Generations list"
          }
        }
      }
    },
    "/repositories": {
      "get": {
        "summary": "List connected repositories",
        "operationId": "listRepositories",
        "responses": {
          "200": {
            "description": "Repositories list"
          }
        }
      }
    }
  }
}