DocuWriter.ai icon

DocuWriter.ai

Generate AI-powered documentation and code analysis

Actions6

Overview

This node integrates with the DocuWriter.ai API to retrieve AI-generated content related to code and documentation. Specifically, for the Generations - Get All operation, it fetches a list of previous generation results created by the service. This can be useful for users who want to review or reuse past AI-generated outputs such as documentation, tests, UML diagrams, or code optimizations without regenerating them.

Practical examples include:

  • Retrieving a history of generated code documentations or test cases.
  • Filtering generations by type to find specific kinds of AI outputs.
  • Limiting the number of returned generations for pagination or performance reasons.

Properties

Name Meaning
Limit Number of generations to return. Must be between 1 and 100. Defaults to 20.
Type Filter Optional string to filter generations by their type (e.g., "codeDocumentation", "umlDiagram"). If empty, no filtering is applied.

Output

The output is a JSON array containing generation objects retrieved from the DocuWriter.ai service. Each object represents a single generation record with details depending on the generation type. The exact structure depends on the API response but typically includes metadata about the generation and its content.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the DocuWriter.ai API via an API key credential configured in n8n.
  • The node uses the base URL from the credential to make authenticated HTTP requests.
  • No additional external dependencies are required beyond network access to the API endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing a limit outside the allowed range (less than 1 or greater than 100) may result in errors or unexpected behavior.
    • Using an invalid or unsupported typeFilter value might return no results or an error if the API does not recognize the filter.

  • Error messages:

    • Authentication errors typically indicate problems with the API key setup; verify the credential configuration.
    • Request errors may include messages about invalid parameters; ensure limit and typeFilter values conform to expected formats.
    • Network or timeout errors suggest connectivity issues with the DocuWriter.ai service.

To resolve errors, check the input parameters, confirm API credentials, and ensure stable internet connectivity.

Links and References

Discussion