> For the complete documentation index, see [llms.txt](https://docs.keyshade.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keyshade.io/contributing-to-keyshade/running-things-locally/api-testing.md).

# API Testing

⁸---\
description: API testing using Bruno

***

## API Testing

We use Bruno to test our APIs. All of our endpoints are tested using Bruno and we maintain a detailed documentation of every endpoint in our Bruno collection. You can find it in [here](https://github.com/keyshade-xyz/keyshade/blob/develop/api-collection/README.md).

Although we recommend to use Bruno, you can always import the collections into your favorite tool.

### Getting started

* For starters, make sure you have Bruno installed on your system. If not, you can download it from [here](https://www.usebruno.com/downloads)

![Download Bruno](https://3494620841-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1uANBbw2pha5LMTqtGvX%2Fuploads%2Fgit-blob-0f5e2a56d945191e15b89f76a3d56e5d37c4953e%2Fdownload_bruno.png?alt=media)

* Once you have Bruno installed, open it up.

![Open Bruno](https://3494620841-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1uANBbw2pha5LMTqtGvX%2Fuploads%2Fgit-blob-6a83901b0cac1ea21e889f0a04b6865a7e05cdcd%2Fopen_bruno.png?alt=media)

* Click on `Import Collection`

![Import Collection](https://3494620841-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1uANBbw2pha5LMTqtGvX%2Fuploads%2Fgit-blob-b1422f9f5e3b6f48356593e5306a829189687838%2Fimport_collection.png?alt=media)

* Point to the [`api-collection`](https://github.com/keyshade-xyz/keyshade/blob/develop/api-collection/README.md) folder

![API Collection](https://3494620841-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1uANBbw2pha5LMTqtGvX%2Fuploads%2Fgit-blob-d5690c274cd4c9c071e6528a9df0ee2f2f088f9a%2Fapi_collection.png?alt=media)

* For every collection in the API, the requests hold one or more examples that you can use to test the API. You can also find the schema of the request itself.

### Making changes to the API

Whenever you make a change to the API that adds / removes / updates one or more requests, you are required to update the corresponding collection in the [api-collection](https://github.com/keyshade-xyz/keyshade/blob/develop/api-collection/README.md) folder. Since the collections are tracked in the branch, we expect you to make all the changes in the same branch which you are working on.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.keyshade.io/contributing-to-keyshade/running-things-locally/api-testing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.