# Endpoints

#### **Start an Audit** <a href="#start-an-audit" id="start-an-audit"></a>

* **Endpoint**: `POST /v1/audits`
* **Purpose**: Initiates a new audit for the specified project or contract.
* **Parameters**:
  * `project_name` (string): The name of your project.
  * `contracts` (file): The smart contract files to audit, provided as file uploads.
* **Example Request**:

  ```
  http
  POST https://api.auditx.com/v1/audits
  Authorization: Bearer YOUR_API_KEY
  Content-Type: multipart/form-data
  ```
* **Form Data**:
  * `project_name`: "MyDeFiProject"
  * `contracts`: \[File Uploads]
* **Retrieve Audit Results**
  * **Endpoint**: `GET /v1/audits/{audit_id}`
  * **Purpose**: Fetches the results of a specific audit.
  * **Parameters**:
    * `audit_id` (string): The unique ID of the audit you want to retrieve.
  * **Example Request**:

```
http
GET  https://api.auditx.com/v1/audits/abc123
Authorization: Bearer YOUR_API_KEY
```

#### **List All Projects** <a href="#list-all-projects" id="list-all-projects"></a>

* **Endpoint**: `GET /v1/projects`
* **Purpose**: Lists all projects associated with your account.
* **Parameters**: None
* **Example Request**

```
http
GET https://api.auditx.com/v1/projects
Authorization: Bearer YOUR_API_KEY
```


---

# Agent Instructions: 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://doc.auditx.net/auditx-educational-program/introduction/api-reference/endpoints.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.