> 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.md).

# API

- [Oz API](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api.md)
- [Basic Scenarios](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/basic-scenarios.md)
- [Liveness](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/basic-scenarios/liveness.md)
- [Best Shot](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/basic-scenarios/liveness/best-shot.md)
- [Action Shot](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/basic-scenarios/liveness/action-shot.md)
- [Biometry (Face Matching)](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/basic-scenarios/biometry.md)
- [Collection (1:N) Check](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/basic-scenarios/collection.md): How to compare a photo or video with ones from your database.
- [Collection (1:N) Management in Oz API](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/basic-scenarios/collection/collection-management-in-oz-api.md)
- [OzCapsula Data Container](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/ozcapsula-data-container.md)
- [Instant API: Non-Persistent Mode](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/instant-api-non-persistent-mode.md)
- [Single Request](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/single-request.md)
- [Authentication and Non-Instant Data Handling](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/use-cases.md)
- [Authentication](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/use-cases/authentication.md)
- [How to Issue a Service Token](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/use-cases/authentication/how-to-issue-a-service-token.md)
- [Uploading Media](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/use-cases/uploading-media.md)
- [Quantitative Results](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/use-cases/quantitative-results.md): This article describes how to get the analysis scores.
- [Using a Webhook to Get Results](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/use-cases/using-a-webhook-to-get-results.md)
- [System Objects](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/system-objects.md): The description of the objects you can find in Oz Forensics system.
- [User Roles](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/user-roles.md)
- [Types of Analyses and What They Check](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/types-of-analyses-and-what-they-check.md): Here, you'll get acquainted with types of analyses that Oz API provides and will learn how to interpret the output.
- [Rules of Assigning Analyses](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/rules-of-assigning-analyses.md): This article covers the default rules of applying analyses.
- [Statuses in API](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/statuses-in-api.md): This article contains the full description of folders' and analyses' statuses in API.
- [Media Tags](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/media-tags.md)
- [Metadata](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/metadata.md)
- [API Error Codes](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/http-return-codes.md)
- [Oz API Postman Collections](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/postman-collections.md)
- [Changelog](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/changelog.md): API changes
- [Oz API Lite (Deprecated)](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api-lite.md): What is Oz API Lite, when and how to use it.
- [API Lite Methods](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api-lite/api-methods.md)
- [Oz API Lite Postman Collection](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api-lite/postman-collections.md)
- [Changelog](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api-lite/changelog.md): API Lite (FaceVer) changes


---

# 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.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.