🔌Understanding Imperial APIs

This guide provides insights into the potential responses from Imperial CAD API requests and offers general information to assist you in understanding and crafting your integration.

post https://imperialcad.app/api/1.1/wf/<API_GOES_HERE>

Rate Limits

Imperial CAD aims to offer flexibility and unrestricted access for our vibrant communities. However, to avoid misuse, we have instituted certain limits. Below are some common responses and their meanings:

Here is some possible outcomes and what they mean:

200 OK

{
  "status": "RATE_LIMIT",
  "message": "You're sending request to frequently, Please slow down. "
}

• This means the provided user has sent a request within the last minute already, and there is no real need run more actions for them just yet.

200 OK

{
  "status": "RATE_LIMIT",
  "message": "Threshold Reached"
}

• This signifies that while the request is valid, the current call has exceeded the threshold of concurrent open calls. Note: This limit is under continuous review and may be adjusted.

400 Bad Request

{
  "status": "NOT_RUN",
  "message": "The condition for the workflow is not met. Workflow won't run"
}

• This can be ALOT of things, but mainly points towards incorrect data being sent such as a community ID, community API key, and anything that requires a discord id must provide a valid user's discord ID and that user must be in active in the same community making the request otherwise that's not considered a valid user.

How to find the community for a public plugin

When user download our scripts they set two convar values, and these are required for even Imperial CAD related scripts.

imperial_community_id 
imperialAPI 

• It's important to note that imperialAPI can usually only be accessed server-side, whereas imperial_community_id can be retrieved on both the server and client sides.

---

More to come, Please leave suggestions in Our Discord!