> For the complete documentation index, see [llms.txt](https://docs.archisketch.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.archisketch.com/guide/dev-en/api-sdk/how-to-use.md).

# How to Use the API

Guiding you through the Archisketch API request formats and endpoints.

> Do you have any questions or suggestions for improvement during API integration?

{% hint style="info" %}
If you have any questions or feedback regarding the Archisketch API integration, please submit them through the [Integration/Development Inquiry](https://www.archisketch.com/ko/enterprisetrial/). You can communicate directly and exchange Q\&As with an Archisketch representative.
{% endhint %}

#### API Header

Please make Archisketch OPEN-API requests in JSON format over an HTTPS environment.

```http
Content-Type: application/json
```

We use API-KEY authentication. Please obtain the authentication token required for X-API-KEY before using the API.

```http
X-API-KEY: {OPEN-API-KEY}
```

#### Archisketch Endpoint URL

A unified production environment endpoint is provided without a separate test environment, allowing for faster integration.

* Production Environment: `https://openapi.archisketch.com`

#### API Request Limits <a href="#api-2" id="api-2"></a>

We limit the number of requests per company to 30 requests per second for writes and 50 requests per second for reads. If you send requests exceeding these limits, some requests may be rejected and return a `TOO_MANY_REQUEST` ErrorType in the response.

#### API Update Policy

Please review the Archisketch API policies below before starting the integration.

* API response fields and error codes may be added or changed without prior notice. Please ensure your implementation is robust to prevent errors caused by updates.
* When an API is scheduled for removal, we will notify you in advance, so please make sure to check our notices.
* For detailed information on API updates, please check the announcements.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.archisketch.com/guide/dev-en/api-sdk/how-to-use.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.