> For the complete documentation index, see [llms.txt](https://docs.keeper.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keeper.io/enterprise-guide/api-troubleshooting/api-explorer-swagger.md).

# API Explorer - Swagger

## Overview

This document will detail using Swagger to help you understand the Family and Student Plans APIs and test your own examples.

## API Explorer with Swagger

1. Go to <https://editor.swagger.io/>
2. Visit & Download the YAML file for the provision endpoint you want to explore:\
   [Family Plans](/enterprise-guide/personal-vaults-for-enterprise-and-business-users/provision-family-plans-via-api.md)\
   [Student Plans](/enterprise-guide/personal-vaults-for-enterprise-and-business-users/provision-student-plans-via-api.md)
3. In Swagger, click on File > Import and select the YAML file downloaded in step 2
4. After importing the YAML file, the swagger website should show the API configuration defined in the YAML file on the Left screen, and the corresponding API explorer on the right side:

<figure><img src="https://4290574019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LO5CAzpxoaEquZJBpYz%2Fuploads%2FZqke0QoMeCaCoVo76W9p%2Fswagger1.png?alt=media&#x26;token=9fe9d478-a41b-4454-b835-0d195f429b1c" alt=""><figcaption><p>This example uses the Family Plan's YAML File</p></figcaption></figure>

5. Expanding the API call on the right side will provide more information on the API endpoint's parameters and responses

<figure><img src="https://4290574019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LO5CAzpxoaEquZJBpYz%2Fuploads%2FJN7wu6xFIEbV7ooiVcmu%2Fswagger2.png?alt=media&#x26;token=745913ba-617a-4095-860e-8322a31112c7" alt=""><figcaption></figcaption></figure>

6. To being testing out the API endpoint, click on the "**Try it out"** button

<figure><img src="https://4290574019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LO5CAzpxoaEquZJBpYz%2Fuploads%2FRH20QmHJ9VmqTcYvCN5P%2Fswagger3.png?alt=media&#x26;token=aabb148a-3006-4d96-95f2-2d95bcb2c71b" alt=""><figcaption></figcaption></figure>

7. After filling out the values for the API Parameters, clicking on "Execute" will execute the API call:

<figure><img src="https://4290574019-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LO5CAzpxoaEquZJBpYz%2Fuploads%2FBkstpFPGPEQxkpKDkkl0%2Fswagger4.png?alt=media&#x26;token=3c206d94-0cb6-4cd1-b30a-305c85bc8d3e" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
For detailed information on the API parameters and how to define them, visit this [page](/enterprise-guide/api-troubleshooting/api-parameters.md)
{% endhint %}

8. After executing, you can scroll to the Response section to view the results


---

# 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://docs.keeper.io/enterprise-guide/api-troubleshooting/api-explorer-swagger.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.