Actions6
Overview
The node "DocuWriter.ai" integrates with an AI-powered documentation and code analysis service. It supports multiple resources and operations, including generating code documentation, test cases, UML diagrams, optimizing code, retrieving generation records, and fetching user info.
Specifically, the Generations - Get operation retrieves a single generation record by its unique ID. This is useful for users who want to fetch details about a previously created generation, such as generated documentation, tests, or other AI outputs stored on the service.
Practical examples:
- Fetching a specific AI-generated code documentation report by its ID.
- Retrieving details of a particular code optimization or UML diagram generation.
- Accessing metadata or results of a past generation for auditing or further processing.
Properties
| Name | Meaning |
|---|---|
| Generation ID | The unique identifier of the generation to retrieve. This is required to specify which generation record to fetch from the service. |
Output
The output is a JSON object representing the detailed data of the requested generation. The exact structure depends on the type of generation but generally includes metadata and content related to that generation (e.g., generated documentation text, test cases, diagrams, or optimization results).
If the generation includes binary data (such as images for UML diagrams), it would typically be encoded or referenced in the JSON response, but this node primarily returns JSON data.
Dependencies
- Requires an API key credential for authenticating with the DocuWriter.ai service.
- The node makes HTTP requests to the DocuWriter.ai API endpoints.
- No additional environment variables are explicitly required beyond the configured API credential.
Troubleshooting
Common issues:
- Invalid or missing Generation ID will cause the API request to fail.
- Network or authentication errors if the API key is incorrect or expired.
- Requesting a generation ID that does not exist may return an error or empty result.
Error messages:
- Errors returned from the API are caught and can be output as error objects if "Continue On Fail" is enabled.
- Typical error messages include "Generation not found" or "Unauthorized" indicating invalid credentials.
Resolutions:
- Verify the Generation ID is correct and exists.
- Ensure the API key credential is valid and has necessary permissions.
- Check network connectivity and API endpoint availability.
Links and References
- DocuWriter.ai Official Website (for API documentation and account management)
- n8n Documentation on Creating Custom Nodes