> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api-lite.md).

# Oz API Lite (Deprecated)

What is Oz API Lite, when and how to use it.

{% hint style="danger" %}
API Lite is deprecated and no longer maintained. Its functionality has been added to API full: see [Instant API](/oz-knowledge/guides/developer-guide/api/oz-api/instant-api-non-persistent-mode.md).
{% endhint %}

Oz API Lite is the lightweight yet powerful version of Oz API. The Lite version is less resource-demanding, more productive, and easier to work with. The analyses are made within the API Lite image.  As Oz API Lite doesn't include any additional services like statistics or data storage, this version is the one to use when you need a high performance.

#### Examples of methods

To check the Liveness processor, [call](/oz-knowledge/guides/developer-guide/api/oz-api-lite/api-methods.md#health-checking-the-status-of-liveness-processor) `GET /v1/face/liveness/health`.

To check the Biometry processor, [call](/oz-knowledge/guides/developer-guide/api/oz-api-lite/api-methods.md#health-biometric-processor-status-check) `GET /v1/face/pattern/health`.

To perform the liveness check for an image, [call](/oz-knowledge/guides/developer-guide/api/oz-api-lite/api-methods.md#detect-presentation-attack-detection) `POST /v1/face/liveness/detect` (it takes an image as an input and displays the evaluation of spoofing attack chance in this image)

To compare two faces in two images, [call](/oz-knowledge/guides/developer-guide/api/oz-api-lite/api-methods.md#extract_and_compare-extracting-and-comparison-of-templates-derived-from-two-images) `POST /v1/face/pattern/extract_and_compare` (it takes two images as an input, derives the biometry templates from these images, and compares them). 

To compare an image with a bunch of images, [call](/oz-knowledge/guides/developer-guide/api/oz-api-lite/api-methods.md#extract_and_compare_n-1-n-template-extraction-and-comparison) `POST /v1/face/pattern/extract_and_compare_n`.

For the full list of Oz API Lite methods, please refer to [API Methods](/oz-knowledge/guides/developer-guide/api/oz-api-lite/api-methods.md).


---

# 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://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api-lite.md?ask=<question>&goal=<user_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.