# API Swagger

What is the Swagger

Swagger is a web-based user interface that allows you to test all API Method Calls. All of the code is pre-written, allowing you to 'drop in' your specific parameters and verify that the results are as expected before taking the time to implement it yourself. You can also use Swagger to better understand any errors you may be experiencing, and we recommend that you do so before contacting our support teams.

## Interface Structure

You will also see that each method can be expanded to reveal various useful options and information:

* Description
* Parameters
  * These are the inputs required for this specific method call
* Possible Responses
  * These are all of the possible, pre defined HTTP response codes + data that the API will respond with, based on the result of your attempted method call
* Try-it-out
  * Execute
    * Run the test method call
  * Actual Response
    * The Specific HTTP Response to this specific attempted method call

### Using the Swagger

To learn how to use the swagger, please read [Getting Started with the Swagger](https://docs.nmkr.io/nmkr-studio-api/api-swagger/get-started-with-the-swagger) and [Swagger Responses and Error Codes](https://docs.nmkr.io/nmkr-studio-api/api-swagger/swagger-responses-and-error-codes).

{% hint style="info" %}
Note - the Project and NFT UID's are now both random strings that cannot be predicted, this extra security feature means that attackers cannot 'guess' the ID, making certain attacks more difficult even if the API Key is compromised.
{% endhint %}

{% hint style="danger" %}
Note - NEVER EXPOSE YOUR API KEY, IF YOU DO, DELETE IT AND MAKE A NEW ONE IMMEDIATELY.
{% endhint %}

### Swagger Mainnet

{% embed url="<https://studio-api.nmkr.io/swagger/index.html>" %}

### Swagger Testnet (preprod)

{% embed url="<https://studio-api.preprod.nmkr.io/swagger/index.html>" %}


---

# 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.nmkr.io/nmkr-studio-api/api-swagger.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.