> 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.md).

# API/SDK

- [Introducing the Archisketch API](https://docs.archisketch.com/guide/dev-en/api-sdk/readme.md)
- [How to Use the API](https://docs.archisketch.com/guide/dev-en/api-sdk/how-to-use.md): Guiding you through the Archisketch API request formats and endpoints.
- [API List](https://docs.archisketch.com/guide/dev-en/api-sdk/api.md): An introduction to API references and sample data.
- [Authentication](https://docs.archisketch.com/guide/dev-en/api-sdk/api/authentication.md)
- [User](https://docs.archisketch.com/guide/dev-en/api-sdk/api/user.md)
- [Category](https://docs.archisketch.com/guide/dev-en/api-sdk/api/category.md)
- [Project](https://docs.archisketch.com/guide/dev-en/api-sdk/api/project.md)
- [Image](https://docs.archisketch.com/guide/dev-en/api-sdk/api/image.md)
- [Space](https://docs.archisketch.com/guide/dev-en/api-sdk/api/space.md)
- [Building](https://docs.archisketch.com/guide/dev-en/api-sdk/api/building.md)
- [Product](https://docs.archisketch.com/guide/dev-en/api-sdk/api/product.md)
- [Modeling](https://docs.archisketch.com/guide/dev-en/api-sdk/api/modeling.md)
- [Component](https://docs.archisketch.com/guide/dev-en/api-sdk/api/component.md)
- [Parametric](https://docs.archisketch.com/guide/dev-en/api-sdk/api/parametric.md)
- [API Integration Guide](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration.md): An introduction to the API integration process.
- [SSO Integration Guide](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/sso-integration.md): This guide walks you through integrating your partner authentication server with Archisketch via SSO (Single Sign-On).
- [Obtaining an API Authentication Token](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/api-token.md): Issue an authentication token and try calling the API.
- [Integrating 3D Products](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/3d-product-integration.md): This guide explains the overall workflow that partner developers should follow when integrating the Archisketch Open API for the first time.
- [Register Modeling](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/3d-product-integration/modeling.md): This guide explains how to create modeling assets by uploading 3D model files.
- [Register Component](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/3d-product-integration/component.md): This guide explains how to create and manage components based on modeling.
- [Register Parametric Component](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/3d-product-integration/parametric.md): This guide explains how to create and manage parametric components that allow dynamic combinations of parameters such as dimensions and colors.
- [Register Product](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/3d-product-integration/product.md): This guide explains how to create and manage products (Sales) based on components.
- [MCP Integration Guide](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/mcp-integration.md): This guide provides instructions on integrating the MCP server to directly search Archisketch API documentation within AI coding tools.
- [Change History](https://docs.archisketch.com/guide/dev-en/api-sdk/api-integration/changelog.md)
- [API FAQ (Frequently Asked Questions)](https://docs.archisketch.com/guide/dev-en/api-sdk/faq.md): FAQ on API Integration and Usage


---

# 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.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.