From e49eea3aead2cf323be083409d2bff9909835e4d Mon Sep 17 00:00:00 2001
From: Ftps <63702646+Tps-F@users.noreply.github.com>
Date: Sun, 21 Jan 2024 14:46:10 +0900
Subject: [PATCH] add api docs on jp

---
 docs/jp/README.ja.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/docs/jp/README.ja.md b/docs/jp/README.ja.md
index 70f483b..f79e95a 100644
--- a/docs/jp/README.ja.md
+++ b/docs/jp/README.ja.md
@@ -82,4 +82,27 @@ rvc infer -m {model.pth} -i {input.wav} -o {output.wav}
 | filter_radius | -fr        | int          | 3             | If >=3: apply median filtering to the harvested pitch results. The value represents the filter radius and can reduce breathiness                                                                                                               |
 | resample_sr   | -rsr       | int          | 0             | Resample the output audio in post-processing to the final sample rate. Set to 0 for no resampling                                                                                                                                              |
 | rms_mix_rate  | -rmr       | float        | 0.25          | Adjust the volume envelope scaling. Closer to 0, the more it mimicks the volume of the original vocals. Can help mask noise and make volume sound more natural when set relatively low. Closer to 1 will be more of a consistently loud volume |
-| protect       | -p         | float        | 0.33          | Protect voiceless consonants and breath sounds to prevent artifacts such as tearing in electronic music. Set to 0.5 to disable. Decrease the value to increase protection, but it may reduce indexing accuracy                                 |
\ No newline at end of file
+| protect       | -p         | float        | 0.33          | Protect voiceless consonants and breath sounds to prevent artifacts such as tearing in electronic music. Set to 0.5 to disable. Decrease the value to increase protection, but it may reduce indexing accuracy                                 |
+
+
+### API Usage
+最初に、サーバーを立ち上げます。
+```sh
+rvc-api
+```
+または
+```sh
+poetry run poe rvc-api
+```
+にて実行されます。
+#### Inference Audio
+```sh
+curl -X 'POST' \
+      'http://127.0.0.1:8000/inference' \
+      -H 'accept: application/json' \
+      -H 'Content-Type: multipart/form-data' \
+      -F 'modelpath={model.pth}' \
+      -F 'input={input audio path}' \
+      -o {output audio path}
+```
+