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?

If you have any questions or feedback regarding the Archisketch API integration, please submit them through the Integration/Development Inquiry. You can communicate directly and exchange Q&As with an Archisketch representative.

API Header

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

Content-Type: application/json

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

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

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.