# Descriptions for API Collections & Endpoints

Adding descriptions to your API collections and endpoints in Akto helps keep your API inventory well-organized and easier to understand for all team members. It’s especially useful for documentation, collaboration, and tracking purposes.

### Steps to Add a Description to an API Collection

<figure><img src="/files/zMwYbsCNcbY05DegUJQa" alt=""><figcaption></figcaption></figure>

1. **Navigate to API Discovery:**
   * On the left sidebar, click on **API Discovery**.
2. **Select the API Collection:**
   * Choose your desired API collection from the list.
3. **Add or Edit the Description:**
   * Click **Add a brief description** (located at the top of the collection view).
   * Enter your description (up to 64 characters).
   * Click anywhere outside the input box or press Enter to save.

***

### Steps to Add a Description to an API Endpoint

<figure><img src="/files/9S0LzKGCugXyn233e6aI" alt="" width="563"><figcaption></figcaption></figure>

1. **View the API Collection:**
   * Go to the **API Discovery** section and select your API collection.
2. **Select the Endpoint:**
   * Click on the endpoint you want to describe.
3. **Add/Edit the Endpoint Description:**
   * In the right panel that opens, you'll see a field under the endpoint path.
   * Click to edit and enter a description (up to 64 characters).
   * Your changes will save automatically or when you click outside the input box.

***

### Why Add Descriptions?

* **Improve clarity:** Helps team members understand the purpose of APIs quickly.
* **Better documentation:** Keeps your API inventory up-to-date with meaningful notes.
* **Ease of collaboration:** New developers or testers can onboard faster.
* **Audit readiness:** Detailed notes aid in security and compliance reviews.

***

### Best Practices

* **Be concise but clear:** Use plain language to describe the API’s function.
* **Include key details:** Mention core use cases (e.g., “Updates lettering item categories for truck signs”).
* **Keep it updated:** Regularly review and revise descriptions as APIs evolve.


---

# 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://docs.akto.io/api-inventory/how-to/descriptions-for-api-collections-and-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.