# OpenAPI & Swagger UI

{% hint style="danger" %}
VatZen is Deprecated since January 2022 and API server will be shut down soon!
{% endhint %}

We have most up-to-date and generated API available in Swagger UI, where you can also play with API and see responses.

You can access OpenAPI resources on the following URLs:

* Swagger UI: <https://api.vatzen.com/openapi>
* JSON OpenAPI specification: <https://api.vatzen.com/openapi-json>
* YAML OpenAPI specification: <https://api.vatzen.com/openapi-yml>

### Using Swagger UI

We'll walk you through the basics of the Swagger UI and how you can use it to test and play with our API.

First, make sure you have your `apiKey`, which you can get from the [VatZen Dashboard](https://dashboard.vatzen.com).

### Authorization

Before making any requests, you will need to authorize yourself with the token. In order to do that, click "Authorize" button.

You will be presented with 2 possible options, enter your api key either via query param, or header. Feel free to choose any of them. Enter your token and click "Authorize"

![Authorization Options](/files/-MFL55hpvlHit9uFfc1I)

### Making Requests

After you authorized yourself, it's very simple to make the request. Let's take Rate endpoint as an example. Let's imagine, we want to fetch all the VAT rates for France. All you need to do is to expand "Rate", enter "FR" and click execute:

![](/files/-MFL5j0wn-JLSF-_LRaq)

After you performed the request, you can see the response below.

![](/files/-MFL5uJQVA8PsW0IkWqh)


---

# 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://documentation.vatzen.com/openapi-and-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.