Consolidated API Overview MediaServer

[DetlefM]

I was tired of constantly switching back and forth between the (old) API page and the changes, so I created/had someone create a consolidated version in Markdown and HTML with the help of ChatBots.
I haven't fully tested it, but at first glance, it looks good.
In case anyone is interested:
It all comes down to the prompt. And the free or monthly OpenAI plan for $20 worked only unreliably. What worked:
Refining the prompt with ChatGPT in several iterations. Then spending 20 cents via the ChatGPT API, and that's it. The tokens are actually manageable. Markdown with approximately 25,000 input tokens and 8,000 output tokens, and the same again for the HTML translation with basic CSS.

MediaServer_OA.zip

 

AI Prompt:
 

Please create API documentation for the MediaServer (formerly Recording Service) in English (Markdown format), using the information from this document and the attachment with API Changes.

http://en.DVBViewer.tv/wiki/Recording_Service_web_API

Important instructions:

The documentation must include every detail from the listed documents, without summarizing, omitting, or abstracting any information.

Include all examples, notes, parameter types, possible variants, and remarks from the source documents.

For each API call, include a section called "Changes", listing every version/date/release where the interface, accepted parameters (including type changes), or output has changed or been extended.

For changes, always note exactly what changed (e.g., new parameters, allowed types, added fields, etc.).

Ignore minor bug fixes unless they affected the interface itself.

Document the API calls in the order of their first introduction, based on the date and version number.

Pay attention to deprecations:

Clearly mark deprecated functions in the main documentation.

Additionally, create a separate section at the end with all deprecated or obsolete API calls and their details.

For each API call, include:

Description

Endpoint and HTTP method

All parameters (with data types, defaults, and details)

All request and response examples (as shown in the documents)

The "Changes" section

Notes and remarks (especially about limitations, deprecation, and usage)

Use clear and consistent Markdown formatting.

The result must be in English and contain the full content from the documents, in as much detail as possible, for use by both developers and AI systems.

Edited July 21, 2025 by DetlefM
Added AI Prompt

[DetlefM]

I wasn't entirely satisfied with my first attempt. The examples and usage parameters weren't enough for me. So I further improved the prompt (or had it improved) and started again with the KIMI AI.

To avoid straining my storage quota, I created a public Github repo for the results (prompts, source files, results).

https://github.com/detlefm/MediaServerAPI

direct link to Github Pages : https://detlefm.github.io/MediaServerAPI/Index.html

Edited July 21, 2025 by DetlefM
Link to Github Pages