> 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/api-integration/3d-product-integration.md).

# Integrating 3D Products

This guide explains the overall workflow that partner developers should follow when integrating the Archisketch Open API for the first time.

This is the overall workflow for integrating the Archisketch Open API. Please follow the steps below in order.

## 1. Issuing an x-api-key

Log in to the Archisketch dashboard to issue your API key. The issued `x-api-key` must be included in the header of all subsequent API requests.

{% hint style="warning" %}
Make sure to keep your `x-api-key` secure so that it is not exposed externally.
{% endhint %}

## 2. Registering Modeling

Upload your 3D model files to create a modeling asset. The generated modeling ID will be used in the next step.

{% content-ref url="/pages/w1ABpbjXhkHSmVC1d1K7" %}
[Register Modeling](/guide/dev-en/api-sdk/api-integration/3d-product-integration/modeling.md)
{% endcontent-ref %}

## 3. Registering Components

Create a component based on the modeling asset. The generated component ID will be used in the next step.

{% content-ref url="/pages/jiDBj6GtgNkCvQpsp4AK" %}
[Register Component](/guide/dev-en/api-sdk/api-integration/3d-product-integration/component.md)
{% endcontent-ref %}

## 4. Registering Parametric Components (Optional)

Proceed with this step if you need parametric components that allow users to dynamically adjust parameters such as dimensions and colors.

{% content-ref url="/pages/vsmN6rcmJQO12pSkaCVj" %}
[Register Parametric Component](/guide/dev-en/api-sdk/api-integration/3d-product-integration/parametric.md)
{% endcontent-ref %}

## 5. Registering Products

Create a commercial product based on the components.

{% content-ref url="/pages/9m6mTnEicpizWPZYVHzo" %}
[Register Product](/guide/dev-en/api-sdk/api-integration/3d-product-integration/product.md)
{% endcontent-ref %}


---

# 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/api-integration/3d-product-integration.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.