# API Swagger

Swaggerとは

Swaggerは、すべてのAPIメソッドコールをテストできるWebベースのユーザーインターフェイスです。すべてのコードは事前に記述されているため、時間をかけて自分で実装する前に、特定のパラメータを「ドロップイン」し、結果が期待通りであることを確認することができます。また、Swaggerを使用することで、発生する可能性のあるエラーをより深く理解することができます。

### インターフェース構造

また、各メソッドを拡張すると、さまざまな便利なオプションや情報が表示されることもおわかりいただけるでしょう：

* 説明
* パラメータ
* 以下は、この特定のメソッドコールに必要な入力です。
* 可能な対応
* これらは、メソッドコールの結果に基づいて、APIが応答する可能性のある、事前に定義されたHTTPレスポンスコードとデータのすべてです。
* Try-it-out（試してみる）
* 実行
* テスト・メソッドのコールを実行する
* 実際の反応
* * この特定のメソッドコールに対する特定のHTTP応答

#### Swaggerの使用

swaggerの使用方法については、「[ Getting Started with the Swagger](https://docs.nmkr.io/nmkr-studio-api/api-swagger/get-started-with-the-swagger)」および「[ Swagger Responses and Error Codes](https://docs.nmkr.io/nmkr-studio-api/api-swagger/swagger-responses-and-error-codes)」を参照してください。

この追加セキュリティ機能により、攻撃者はIDを「推測」することができなくなり、APIキーが漏洩した場合でも特定の攻撃をより困難にすることができます。

APIキーは絶対に公開しないでください。もし公開した場合は、すぐに削除して新しいAPIキーを作成してください。

### Swaggerメインネット

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

### Swaggerテストネット（pre-prod）

{% 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/jp/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.