> For the complete documentation index, see [llms.txt](https://docs.tvheadend.org/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tvheadend.org/documentation/development/htsp/http-proxy-examples.md). # HTTP Proxy Examples The HTSP `api` method can be used as a proxy to access the HTTP/JSON API. This allows HTSP-only clients access to any JSON feature, including JSON-only features.\ \ Data exchanged to and from the TVH server is achieved by encapsulating the required HTTP/JSON parameters within the HTSP message.\ \ TVH expects to receive encapsulated JSON data and will respond with a HTSP map representing the JSON data returned. Also see: [JSON API](/documentation/development/json-api.md). ## HTSP `API` Syntax Summary Request: ``` args msg[] optional HTTP arguments path str required HTTP path ``` Reply: ``` response msg[] required JSON response ``` ## Simple Request To execute the HTTP API command:\ `http://TVH:9981/api/channel/grid`\ \ Set the `path` field to `channel/grid` and send the request. The `args` field is not required.\ \ The response will be a HTSP `map` containing an element named `response`. This element will be a `map` containing the JSON response presented as HTSP elements. ## Intermediate Request To execute the HTTP API command:\ `http://TVH:9981/api/channel/grid?sort=number&dir=desc`\ \ Set the path to `channel/grid` as in the previous example.\ \ The `arg` field must be set to type `map`, and in this example, contain two `str` elements.\ \ Map `str` element named `sort` should contain the value `number` and map `str` element named `dir` should contain the value `desc`. ## Advanced Request To execute the HTTP API command:\ `http://TVH:9981/api/dvr/entry/create`\ \ Set the path to `dvr/entry/create`.\ \ As with the previous example, the `args` field must be set to type `map`.\ \ **Method 1 - JSON String**\ \ Create a JSON string containing the properties required to complete the request as detailed in the [JSON API documentation](/documentation/development/json-api.md). In this example, to create a new DVR entry.\ \ Within that `map`, create a `str` element named `conf` that contains the required JSON string.\ \ **Method 2 - HTSP Map**\ \ Instead of creating a JSON string, create a HTSP `map` where each element name matches the name of the JSON property and contains the required property value.\ \ `args` should be a `map` that contains another `map` named `conf` that contains another `map` with the required JSON data represented as HTSP elements. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.tvheadend.org/documentation/development/htsp/http-proxy-examples.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.