> For the complete documentation index, see [llms.txt](https://doc-op.blurit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc-op.blurit.io/2.0/blurit-on-premise/usage/api.md).

# API

The BlurIt OP API offers several functionalities. It allows you to obtain the current license by using the GET method on the [`/api/license`](/2.0/blurit-on-premise/usage/api/license.md) endpoint. Additionally, you can add a new license by using the POST method on the same endpoint. If a license already exists, it will be replaced by the new license.

Furthermore, the API provides the capability to add a blur task to the queue by using the POST method on the [`/api/blur_it`](/2.0/blurit-on-premise/usage/api/tasks.md) endpoint. You can also add a blur task for a directory by using the POST method on the [`/api/blur_it/directory`](/2.0/blurit-on-premise/usage/api/tasks/process-a-directory.md) endpoint.

Moreover, the API allows you to retrieve the status of a task by using the GET method on the [`/api/task/{task_id}`](/2.0/blurit-on-premise/usage/api/tasks/get-the-status-of-a-task.md) endpoint, where "task\_id" is the task identifier.

\
The API documentation can be found at `http://<HOST>:<API_PORT>/docs`, where `HOST` is the IP address of the machine, and `API_PORT` is the value configured in the [Configuration](/2.0/blurit-on-premise/installation/configuration.md) section (default value is `8080`).

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td>License</td><td></td><td><a href="/pages/fyzHZmNTxiZdMLer38C5">/pages/fyzHZmNTxiZdMLer38C5</a></td></tr><tr><td></td><td>Blur it</td><td></td><td><a href="/pages/o6O0IRb9m627GmtW8A4A">/pages/o6O0IRb9m627GmtW8A4A</a></td></tr><tr><td></td><td>Blur it directory</td><td></td><td><a href="/pages/WmpKlZGkMqQi7MBpanHf">/pages/WmpKlZGkMqQi7MBpanHf</a></td></tr><tr><td></td><td>Task</td><td></td><td><a href="/pages/epuVjx0DYx1XI0b1chXz">/pages/epuVjx0DYx1XI0b1chXz</a></td></tr></tbody></table>


---

# 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-op.blurit.io/2.0/blurit-on-premise/usage/api.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.