# Using Swagger UI

The Link11 WAAP API is available in [Swagger UI](https://swagger.io/). This tool provides design documentation, and can also be used to submit API calls directly to your planet.

## Location

By default, the API is available in Swagger UI at:

`{your planet name}/api/v4.0/openapi`. 

## Access

Using Swagger UI will require the user to be logged into the planet with a sufficient [Access Level](/console-walkthrough/system/users-management.md#user-parameters). 

{% hint style="info" %}
Swagger will display the entire API. However, the availability of individual routes is dependent upon the user's Access Level. A request sent with insufficient permissions for the route will fail.
{% endhint %}

{% hint style="warning" %}
If Swagger UI receives a request and the response is an HTML document, the most likely cause is the user is not logged in, or is logged in with insufficient permissions. 
{% endhint %}

## Namespaces

The Swagger interface shows the namespaces and data models for the API. Often, each one is initially collapsed, as in this example:

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

Expanding a namespace reveals the endpoints within it:

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

Expanding an endpoint reveals more information about required inputs (if any) and the information that will be returned in the response.

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

Some endpoints, as in the example above, do not require any inputs. Others require specific parameters:

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

... or other inputs, such as a request body.

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

## Running API calls

Selecting the **Try it out** button will enable the editing of the required inputs, if any. Once the required inputs have been completed, the system will:

* display a command that can be submitted via curl (as explained [here](/using-the-product/the-link11-waap-api/using-curl.md)), and
* display an **Execute** button, which if selected will submit the command to the system and display the results.

Swagger allows you to interact with the API, try different commands, and see what responses will be generated.


---

# 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://waap.docs.link11.com/using-the-product/the-link11-waap-api/using-swagger-ui.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.