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

# Introduction

> Welcome to the Siit API

## Caveat

Our public API is available during Trial and for customers on `Standard` & `Pro` plans.

## Base URL

The base url of the public api is [`https://api.siit.io`.](https://api.siit.io.) The API is versioned with a `/v1` suffix.

## A note about Resources

Our API uses prefixed **UID**s to identify the type of resources we're working with.
Here is a non-exhaustive list of resources you might encounter and their corresponding **UID** format:

| Resource                                                          | UID Format | Additional note                 |
| ----------------------------------------------------------------- | ---------- | ------------------------------- |
| [Request](/api-reference/request/retrieve-a-request)              | `req_x`    | (or `REQx` for legacy objects)  |
| [User](/api-reference/user/retrieve-a-user)                       | `u_x`      | (or `Ux` for legacy object)     |
| [Application](/api-reference/application/retrieve-an-application) | `s_x`      | (or `Sx` for legacy object)     |
| [Service](/api-reference/service/retrieve-a-service)              | `wa_x`     | (or `WAx` for legacy object)    |
| [Workflow](/api-reference/workflow/retrieve-a-workflow)           | `wfe_x`    | (or `WFEx` for legacy object)   |
| [Equipment](/api-reference/equipment/retrieve-an-equipment)       | `ueq_x`    | (or `UEQx` for legacy object)   |
| [Equipment Category](/api-reference/equipment/list-categories)    | `eqcat_x`  | (or `EQCATx` for legacy object) |

## Rate limiting

Please note that requests are limited to `60 requests / minutes`. Contact us if you need higher quota.

Queries made to our API will return custom headers:

| Header                | Description                                                                                                                        |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `X-SiitApi-Limit`     | The number of HTTP requests allowed / period                                                                                       |
| `X-SiitApi-Remaining` | How many HTTP requests remain for the current period                                                                               |
| `X-SiitApi-Reset`     | This header is only returned on when you have been rate-limited and represents the timestamp at which you can start querying again |