From 799efd38f3aaf7a4ac8cbbc9e87f53d4e5ce6991 Mon Sep 17 00:00:00 2001 From: Ean Milligan Date: Wed, 23 Jul 2025 01:25:24 -0400 Subject: [PATCH] API docs update --- docs/API.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/API.md b/docs/API.md index c3b0937..143d1b6 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,5 +1,5 @@ ## The Artificer API -The Artificer features an API that allows authenticated users to roll dice into Discord from third party applications (such as Excel macros). The API has a couple endpoints exposed to all authenticated users allowing management of channels that your API key can send rolls to. APIs requiring administrative access are not listed below. +The Artificer features an API that allows authenticated users to roll dice into Discord from third party applications (such as Excel macros). The API has a couple endpoints exposed to all authenticated users allowing management of channels that your API key can send rolls to. Guilds Owners or Admins must run the `[[api allow` command for any users to be able to use the `/api/roll` endpoint. @@ -14,6 +14,6 @@ Every API request **requires** the header `X-Api-Key` with the value set to the Official API URL: `https://artificer.eanm.dev/api/` -API Documentation can be found in the `.bruno` folder, which can be viewed in [Bruno](https://www.usebruno.com/). +API Documentation can be found in the `.bruno` folder, which can be viewed in [Bruno](https://www.usebruno.com/). API requests listed in the `Authenticated/Admin Requests` are only available to the admin user defined in `config.ts`. -API Key management via a basic GUI is available on the [API Tools](https://artificer.eanm.dev/) website. \ No newline at end of file +API Key management via a basic GUI is available on the [API Tools](https://artificer.eanm.dev/) website.