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

# Introduction

> An overview of the Smile REST API, including its conventions and base URL.

The Smile API is organized around REST. It has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. The API uses built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients, and supports cross-origin resource sharing, so you can interact securely with the API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). All API responses return JSON, including errors.

For uptime information, refer to the [Smile status page](https://status.smile.io/).

<Panel>
  ```bash Base URL theme={null}
  https://api.smile.io/v1
  ```
</Panel>