> For the complete documentation index, see [llms.txt](https://docs.malwation.com/cdr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.malwation.com/cdr/api-documentation.md).

# API Documentation

*If you have any further questions, feel free to ask it this email:* \
\&#xNAN;***<batuhan.isildak@malwation.com>***

{% hint style="info" %}
If you want to access Swagger docs, navigate to **/docs** in your CDR url. And also, if you want to get the JSON of the Swagger file, navigate to **/docs-json**.
{% endhint %}

{% hint style="info" %}
Every page in this documentation, like *Start Submisssion* has the **OpenAPI Documentation** of the request and an **Example Response.**&#x20;
{% endhint %}

### Status IDs & Explanations

```json
{
    "status": 1 // Received -> Submission is received from the server, but not finished yet
    "status": 2 // Finished -> Submission is finished and the "result" key is set with the result of the submission
}
```

### Example Result of a Finished Submission

```json
{
	"type": "file",
	"name": "sample.docx",
	"fileId": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b",
	"resultId": "a3d68330-4155-469c-a393-beaa645015da",
	"size": 46516,
	"hashes": {
		"sha256": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b",
		"sha1": "35d4cdeea9bf51902ca268af911c9d527af3d35e",
		"md5": "480f4b4ffb6cca1b872cf55329a8881e"
	},
	"status": 2,
	"level": 0,
	"files": [
		{
			"name": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b_sanitized.docx",
			"id": "336ccc96-286c-4a12-afce-4efe2f8fdba4"
		}
	],
	"message": "Submission is finished",
	"result": {
		"filename": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b_sanitized.docx",
		"log": {
			"description": "File sanitized successfully.",
			"removed": [
				"Metadata"
			],
			"sanitized": [
				"Image"
			],
			"processing time": "7.50170 seconds"
		}
	}
}
```

{% content-ref url="/pages/pCpBvYEUEtFhI24t6Y7u" %}
[Start Submission](/cdr/api-documentation/start-submission.md)
{% endcontent-ref %}

{% content-ref url="/pages/uzI3vrpl7JMLd6PSpY1s" %}
[Listen Submission](/cdr/api-documentation/listen-submission.md)
{% endcontent-ref %}

{% content-ref url="/pages/oKDh8kzEhIAzhWwel2p7" %}
[Download Sanitized File](/cdr/api-documentation/download-sanitized-file.md)
{% endcontent-ref %}


---

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

```
GET https://docs.malwation.com/cdr/api-documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.