Component

Get Component List

get

Retrieves the enterprise's component list with pagination.

Pagination

• Offset-based paging (starts from 0)

• limit: page size (min 1, max 100)

• Check existence of the next page using hasNext in the response

Filter Conditions

• categoryId: Category ID filter

• name: Name search keyword (partial match)

• sortType: Sort criteria (ID_DESC, ID_ASC, NAME_ASC, NAME_DESC, UPDATED_ASC, UPDATED_DESC)

Authorizations

open-api-key

Query parameters

offsetinteger · int32Required

Page number (starts from 0, offset paging)

limitinteger · int32Required

Page size (min: 1, max: 100)

categoryIdstringOptional

Category ID

namestringOptional

Name search keyword

sortTypestring · enumOptional

Sort Type

Default: ID_DESCPossible values:

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

get/api/v1/components

HTTPcURLJavaScriptPython

GET /api/v1/components?offset=1&limit=1 HTTP/1.1
Host: openapi.archisketch.com
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Create Component

post

Creates a new component.

Authorizations

open-api-key

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

post/api/v1/components

HTTPcURLJavaScriptPython

POST /api/v1/components HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Upload Component Assets

post

Uploads assets for a component.

Authorizations

open-api-key

Path parameters

idstringRequired

Component ID

Body

multipart/form-data

assetTypestring · enumRequired

Component asset type

Possible values:

filesstring · binary[]Required

File list

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

post/api/v1/components/{id}/assets

HTTPcURLJavaScriptPython

POST /api/v1/components/{id}/assets HTTP/1.1
Host: openapi.archisketch.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 48

{
  "assetType": "PREVIEW_IMAGE",
  "files": [
    "binary"
  ]
}

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Get Single Component

get

Retrieves component and modeling information by ID.

Authorizations

open-api-key

Path parameters

idstringRequired

Component ID

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

get/api/v1/components/{id}

HTTPcURLJavaScriptPython

GET /api/v1/components/{id} HTTP/1.1
Host: openapi.archisketch.com
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Modify Component Basic Information

patch

Modifies the basic information of a component.

Authorizations

open-api-key

Path parameters

idstringRequired

Component ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

patch/api/v1/components/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/components/{id} HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Modify Component Modeling

patch

Modifies the modeling information connected to the component.

Authorizations

open-api-key

Path parameters

idstringRequired

Component ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

patch/api/v1/components/{id}/modeling

HTTPcURLJavaScriptPython

PATCH /api/v1/components/{id}/modeling HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Modify Component Editor Settings

patch

Modifies the editor settings of a component.

Authorizations

open-api-key

Path parameters

idstringRequired

Component ID

Body

application/json

anyOptional

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

patch/api/v1/components/{id}/editor

HTTPcURLJavaScriptPython

PATCH /api/v1/components/{id}/editor HTTP/1.1
Host: openapi.archisketch.com
Content-Type: application/json
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content

Get Component BOM

get

Retrieves the flat BOM structure of a component by ID.

Authorizations

open-api-key

Path parameters

idstringRequired

Component ID

Responses

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

application/json

anyOptional

get/api/v1/components/{id}/bom

HTTPcURLJavaScriptPython

GET /api/v1/components/{id}/bom HTTP/1.1
Host: openapi.archisketch.com
Accept: */*

200

All responses return 200 (including success and failure) (5xx is exposed only in error conditions)

No content