> For the complete documentation index, see [llms.txt](https://doc.faceplugin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.faceplugin.com/face-recognition-sdk/open-source-face-recognition-javascript-sdk.md).

# Open Source Face Recognition Javascript SDK

### Code <a href="#setup" id="setup"></a>

{% embed url="<https://github.com/Faceplugin-ltd/FaceRecognition-LivenessDetection-Javascript>" %}
Completely Free and Open Source Face recognition Javascript SDK
{% endembed %}

### Overview <a href="#setup" id="setup"></a>

The world's 1st **Completely Free** and **Open Source** **Face Recognition Javascript SDK** for developers to integrate face recognition and liveness detection capabilities into web frontend. Supports real-time, high-accuracy face recognition with deep learning models.\
This is **on-premise face recognition SDK** which means everything is processed in your browser and **NO** data leaves it.\
\
**Please contact us if you need the SDK with higher accuracy.**

### Setup

```
npm install faceplugin
```

### APIs

* **Face Detection**

  ```
  loadDetectionModel()
  detectFace(session, canvas_id)
  ```
* **Face Landmark Extraction**

  ```
  loadLandmarkModel()
  predictLandmark(session, canvas_id, bbox)
  ```
* **Face Liveness Detection**

  ```
  loadDetectionModel()
  detectFace(session, canvas_id)
  ```
* **Face Expression Detection**

  ```
  loadExpressionModel()
  predictExpression(session, canvas_id, bbox)
  ```
* **Face Pose Estimation**

  ```
  loadPoseModel()
  predictPose(session, canvas_id, bbox, question)
  ```
* **Eye Closeness Detection**

  ```
  loadEyeModel()
  predictEye(session, canvas_id, landmark)
  ```
* **Gender Detection**

  ```
  loadGenderModel()
  predictGender(session, canvas_id, landmark)
  ```
* **Age Estimation**

  ```
  loadAgeModel()
  predictAge(session, canvas_id, landmark)
  ```
* **Face Recognition**

  ```
  loadFeatureModel()
  extractFeature(session, canvas_id, landmarks)
  ```


---

# 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://doc.faceplugin.com/face-recognition-sdk/open-source-face-recognition-javascript-sdk.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.