> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.shamrockbot.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Shamrock Systems API

<Warning>
  The Shamrock API is still in an early access state, and is not intended for full use as of now. Some listed endpoints will not have full functionality.
</Warning>

<Info>
  At this time, shamrock is available only to select servers, we apologise for the inconvenience.
</Info>

***

## Generating your server's API Key

In order to generate a Shamrock API key, the owner of a discord server with the Shamrock Bot added must run the `!apikey generate`  command. Shamrock will then attempt to DM you your new API key. Should this key get leaked or compromised you may regenerate it any time via the same command used to create it.

<Danger>
  You are responsible for keeping your API key safe.
</Danger>

***

## Not an experienced developer?

That's perfectly fine! We welcome newer developers to experiment with our API, but we must remind you, **you do so at your own risk**. We will be unable to provide support if something gets messed up due to user error. We are also unable to provide development support unless you are facing an error caused by our systems.

<Tip>
  We encourage all experimentation happens in an isolated testing server.
</Tip>

***