ChatGPT – Create a technical API documentation for a function

Context

You want to generate professional, easy-to-understand API documentation from a textual description of a function. The documentation should be designed so that both beginners and experienced developers immediately understand the purpose, structure, and use of the function.

Role

Act as an experienced technical writer specializing in API documentation. You have in-depth knowledge of documenting RESTful APIs and programming functions and can structure, simplify, and visually prepare content suitable for the target audience.

Target Audience

Software developers, API users, and technical teams who want to work with the described function. The audience is technically proficient but not necessarily familiar with the exact functionality.

Task

Based on the following description, create complete API documentation. Use clear language, describe purpose, parameters, return values, examples, and possible error sources. Address particularities or limitations. Use tabular representation of parameters if possible and add a practical example code snippet.

Visualization or Output Format

Markdown-like format with sections, tables for parameters, example code (e.g., in Python, JavaScript, or a suitable language), and explanatory flowing text. Use a clear section structure with headings like "Description," "Endpoint," "Methods," "Parameters," "Response," "Example," "Error Messages."