> For the complete documentation index, see [llms.txt](https://docs.vodlix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vodlix.com/developer-guide/api-documentation/guidelines-for-session-initialization.md).

# Guidelines for Session Initialization

We initiate our session using the Base Configs API endpoint (`/api/base/configs`). This API call expects certain parameters to be passed in the query string to optimize session creation and management.

Below are the mandatory and latest values for the query parameters:

* **app\_name**: Specifies the application initiating the session. Valid values are:
  * android\_app
  * ios\_app
  * tvos\_app
  * smarttv\_app
  * androidtv\_app
  * web\_app
  * roku\_app
* **device\_type**: Describes the user's device. Acceptable values include:
  * desktop
  * mobile
  * tablet
  * tv
  * vr
  * chromecast
* **app\_version**: Denotes the version of the application, if relevant. It defaults to `1.0` if not specified.
* **app\_identifier**: A unique identifier for the app, typically in the format `web.{PLATFORM_NAME}.vodlix`, unless specified otherwise.
* **device\_name**: Specifies the name of the user's device. If not provided, it is automatically detected.
* **browser**: Represents the browser used, applicable for web sessions. It identifies the browser, such as 'chrome', 'firefox', 'safari', etc. If not specified, it's automatically detected.
* **browser\_version**: Provides the version of the browser used. If not specified or detectable, it defaults to `123`.
* **os**: Indicates the operating system of the device, such as 'windows', 'android', 'ios', etc. If not specified, it's automatically detected.
* **os\_version**: Provides the version of the operating system, formatted as a float. If not specified, it's detected and converted from a format like "10\_3\_1" to "10.3.1".

It's essential to ensure all parameters are correctly passed for accurate session initialization and efficient tracking. This facilitates the system in providing a personalized user experience and better analytics.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.vodlix.com/developer-guide/api-documentation/guidelines-for-session-initialization.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.