> 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/blurit-on-premise/usage/api/tasks/process-a-file.md).

# Process a file

## Blur It Post

> Add a blurit task in task queue.

```json
{"openapi":"3.0.2","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/blur_it":{"post":{"summary":"Blur It Post","description":"Add a blurit task in task queue.","operationId":"blur_it_post_api_blur_it_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetectAndBlurBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRespsonse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DetectAndBlurBody":{"title":"DetectAndBlurBody","required":["input_media"],"type":"object","properties":{"input_media":{"$ref":"#/components/schemas/InputFile"},"output_media":{"title":"Output video/image informations","allOf":[{"$ref":"#/components/schemas/OutputMedia"}]},"output_json":{"title":"Output JSON informations (contains detections' descriptions)","allOf":[{"$ref":"#/components/schemas/OutputJSON"}]},"blur_plates":{"title":"Should we blur plates ?","type":"boolean","default":true},"blur_heads":{"title":"Should we blur heads ?","type":"boolean","default":true},"keep_audio":{"title":"Should we keep audio in the output media ?","type":"boolean","default":true}},"description":"Detect and blur route's body.\nAt least one of output_media or output_json is needed."},"InputFile":{"title":"InputFile","required":["protocol","path"],"type":"object","properties":{"protocol":{"title":"Must be 'file' (for local storage) or 's3' (for S3 storage)","type":"string"},"path":{"title":"File's relative path","type":"string"},"expires_at":{"title":"Input file's expiration date. Works only with S3 storage.","type":"string"},"auto_delete":{"title":"If set to True (or not set), deletes the input file after processing.","type":"boolean","default":true}},"description":"Input File structure."},"OutputMedia":{"title":"OutputMedia","required":["protocol","path"],"type":"object","properties":{"protocol":{"title":"Must be 'file' (for local storage) or 's3' (for S3 storage)","type":"string"},"path":{"title":"File's relative path","type":"string"},"lifespan":{"title":"Number of seconds the output will be stored. Works only with S3 storage.","type":"integer"}},"description":"Output Media file structure."},"OutputJSON":{"title":"OutputJSON","required":["protocol","path"],"type":"object","properties":{"protocol":{"title":"Must be 'file' (for local storage) or 's3' (for S3 storage)","type":"string"},"path":{"title":"File's relative path","type":"string"},"lifespan":{"title":"Number of seconds the output will be stored. Works only with S3 storage.","type":"integer"}},"description":"Output JSON file structure."},"TaskRespsonse":{"title":"TaskRespsonse","required":["task_id"],"type":"object","properties":{"task_id":{"title":"Unique task hash","type":"string"}},"description":"Task POST result structure"},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}}}
```


---

# 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/blurit-on-premise/usage/api/tasks/process-a-file.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.
