# Introduction

{% hint style="info" %}
:flag\_it: Questa documentazione è disponibile esclusivamente in lingua **inglese**.
{% endhint %}

Deepstone offers REST API so that you can programmatically integrate our service in your application.

## Request and response encoding

All of our application programming interfaces (APIs) accept request bodies encoded in JSON format, and they provide responses encoded in JSON format as well. We have designed our APIs to efficiently handle the exchange of data in this widely-used and versatile format, ensuring a smooth and standardized communication process between clients and our services.

### Error codes

The API utilizes traditional HTTP error codes to communicate status and error information between the client and the server in a standardized manner, ensuring seamless interoperability and effective error handling throughout the communication process.

| Error Code                                                 | Description                                                                                                                                                                                                                                                          |
| ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><strong>2xx</strong><br>OK</p>                          | Everything worked as expected.                                                                                                                                                                                                                                       |
| <p><strong>400</strong><br>Bad request</p>                 | <p>The request was unacceptable, often due to missing or invalid parameter(s). In this case<br>a JSON-encoded error response is returned.</p>                                                                                                                        |
| <p><strong>401</strong><br>Unauthorized</p>                | User is not authorised to perform the request.                                                                                                                                                                                                                       |
| <p><strong>429</strong><br>Too Many Requests</p>           | <p>Too many requests hit the API too quickly.<br>We recommend you to throttle request rate as per the <br>value of <code>X-RateLimit-Limit</code> and <code>X-RateLimit-Reset</code> response headers and stay within <a href="broken-reference">Rate Limit</a>.</p> |
| <p><strong>500, 502, 503, 504</strong><br>Server error</p> | Something went wrong with Deepstone API. Please create a support ticket by emailing us at <support@deepstone.cloud>                                                                                                                                                  |
|                                                            |                                                                                                                                                                                                                                                                      |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://resource.deepstone.cloud/deepstone-api/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.