diff --git a/src/docs/api.md b/src/docs/api.md new file mode 100644 index 0000000..b975779 --- /dev/null +++ b/src/docs/api.md @@ -0,0 +1,44 @@ +--- +title: API Reference +description: The API reference is a detailed documentation of all the endpoints available in the SVGL API. +--- + + + +## Introduction + +SVGL API is a RESTFul API that allows you to get all the information of the SVGs that are in the repository. + +## Limitations + +The API is currently open to everyone and does not require any authentication. However, there is a limit of **50** requests per day per IP address. If you exceed this limit, you will receive a _429_ error. + +## Base URL + +The base URL for the API is: + +```bash +https://svgl.vercel.app/api/svgs +``` + +## Endpoints + +