# Froomle product documentation

> Official public documentation for integrating the current Froomle platform.

This is a navigation index, not the full documentation. Choose a task below or
open a section index, then read the linked page before answering. Each page entry
provides a Markdown page and an HTML alternative. If a tool cannot open either,
say so rather than answering from the index alone. For exact API contracts,
check the API reference and verify any AI-generated examples against it.

## Common tasks

- **Start an integration:** [Getting Started](https://docs.froomle.com/froomle-doc-main/v2/guide/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/index.html)) — Follow the onboarding steps from account setup through QA.
- **Synchronize items:** [Item Catalog](https://docs.froomle.com/froomle-doc-main/v2/guide/item-sync.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/item-sync.html)) — Prepare and maintain the item catalog used by recommendations.
- **Track events and recommendation clicks:** [Event Model and Tracking Contract](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/tracking-events.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/tracking-events.html)) — Choose events and review recommendation attribution examples.
- **Build a recommendation request:** [Recommendation Request Model](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/recommendation-requests.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/topics/recommendation-requests.html)) — Understand lists, context, identity, filters, and exclusions.
- **Integrate with the frontend SDK:** [SDK](https://docs.froomle.com/froomle-doc-main/v2/js_lib/jslib.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/js_lib/jslib.html)) — Use the browser SDK for recommendations and tracking.
- **Integrate events manually:** [Manual Event Integration](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/events.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/guide/manual-integration/events.html)) — Send events through the API or other agreed delivery methods.
- **Check exact event fields:** [Events API](https://docs.froomle.com/froomle-doc-main/v2/api_reference/events/events_api.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/api_reference/events/events_api.html)) — Read the Events API endpoint and field reference.

## Documentation sections

- **Overview:** [What is the Froomle platform?](https://docs.froomle.com/froomle-doc-main/v2/index.md) ([HTML](https://docs.froomle.com/froomle-doc-main/v2/index.html)) — What the Froomle platform does.
- [Guides](https://docs.froomle.com/froomle-doc-main/v2/guide/llms.txt): Integration workflow, event tracking, recommendation requests, identity, and manual integrations. (40 pages)
- [Frontend SDK](https://docs.froomle.com/froomle-doc-main/v2/js_lib/llms.txt): Browser SDK setup, recommendation rendering, and event attribution. (4 pages)
- [API reference](https://docs.froomle.com/froomle-doc-main/v2/api_reference/llms.txt): Endpoint and schema details for events, recommendations, items, search, and audiences. (21 pages)
- [Diagnostics overlay](https://docs.froomle.com/froomle-doc-main/v2/diagnostics/llms.txt): Tools for investigating integration behavior in the browser. (2 pages)
- [Froomle overlay](https://docs.froomle.com/froomle-doc-main/v2/overlay/llms.txt): In-page inspection and performance information for authorized users. (2 pages)