# Developer Reference

## Introduction

This document serves as a reference for third party developers wishing to target **ClearXP**'s implementation of the [**Experience API**](https://en.wikipedia.org/wiki/Experience_API). Whether building eLearning content or a custom integration, the information provided within this document should provide a solid grounding for accomplishing most tasks.

Not sure what **ClearXP** is capable of? Find out at [**clearxp.com**](https://clearxp.com)

## Philosophy

The **Experience API** (xAPI) introduces concepts and a technical definition for defining interactions between a learner and digital or physical training materials. These *experiences* can range from simple to incredibly complex, but what's not covered in the xAPI specification is how these interactions are to be interpreted by the **Learning Record Store** (LRS).

Furthermore, with many of the restrictions imposed by **SCORM** now lifted, we're seeing more complex applications being built that are required to pull data back from the **LRS** to provide a richer learning experience. The **xAPI** defines a rudimentary mechanism for the learning application to manage this data via *document resources* (see [State](https://dev.clearxp.com/xapi-reference/state) and [Activity Profile](https://dev.clearxp.com/xapi-reference/activity-profile) references) but this has the potential to cause a disconnect between the application and the LRS' own reporting tools.

> ***Clear LRS provides a superset of the Experience API via xAPI-compliant extensions to fill the gap between recording data and reporting on it.***

**Clear LRS** enables learning content developers to build rich experiences by providing a means to pull back aggregate training data via standard xAPI endpoints.

## Next Steps

Follow the **Getting Started** guide to begin your integration journey or jump straight to the API reference if you're already familiar with the Experience API.

{% content-ref url="getting-started" %}
[getting-started](https://dev.clearxp.com/getting-started)
{% endcontent-ref %}

{% content-ref url="clear-api-reference" %}
[clear-api-reference](https://dev.clearxp.com/clear-api-reference)
{% endcontent-ref %}

We're always happy to help – please contact us via our website at [**clearxp.com**](https://clearxp.com) if you'd like a hand in adopting the Experience API.


---

# Agent Instructions: 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:

```
GET https://dev.clearxp.com/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
