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

# Parametric

## Update Parametric Component

> Modifies a parametric component.

```json
{"openapi":"3.1.0","info":{"title":"Open API","version":"snapshot"},"tags":[{"name":"Parametric"}],"servers":[{"url":"https://openapi.archisketch.com"}],"security":[{"open-api-key":[]}],"paths":{"/api/v1/parametric/components/{id}":{"put":{"tags":["Parametric"],"summary":"Update Parametric Component","description":"Modifies a parametric component.","operationId":"modifyParametricComponent","parameters":[{"name":"id","in":"path","description":"Component ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parametric component information to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParametricComponentModifyRequest"}}},"required":true},"responses":{"200":{"description":"All responses return 200 (including success and failure) (5xx is exposed only in error conditions)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseParametricComponentIdResponse"}}}}}}}}}
```

## Create Parametric Component

> Creates a new parametric component.

```json
{"openapi":"3.1.0","info":{"title":"Open API","version":"snapshot"},"tags":[{"name":"Parametric"}],"servers":[{"url":"https://openapi.archisketch.com"}],"security":[{"open-api-key":[]}],"paths":{"/api/v1/parametric":{"post":{"tags":["Parametric"],"summary":"Create Parametric Component","description":"Creates a new parametric component.","operationId":"createParametricComponent","requestBody":{"description":"Parametric component information to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParametricComponentCreateRequest"}}},"required":true},"responses":{"200":{"description":"All responses return 200 (including success and failure) (5xx is exposed only in error conditions)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseParametricComponentIdResponse"}}}}}}}}}
```

## Get Component Parameter List

> Retrieves the parameter list of a parametric component.

```json
{"openapi":"3.1.0","info":{"title":"Open API","version":"snapshot"},"tags":[{"name":"Parametric"}],"servers":[{"url":"https://openapi.archisketch.com"}],"security":[{"open-api-key":[]}],"paths":{"/api/v1/parametric/components/{componentId}/parameters":{"get":{"tags":["Parametric"],"summary":"Get Component Parameter List","description":"Retrieves the parameter list of a parametric component.","operationId":"getComponentParameters","parameters":[{"name":"componentId","in":"path","description":"Component ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"All responses return 200 (including success and failure) (5xx is exposed only in error conditions)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseComponentParametersResponse"}}}}}}}}}
```

## Create Component Parameters

> Creates parameters in a parametric component.

```json
{"openapi":"3.1.0","info":{"title":"Open API","version":"snapshot"},"tags":[{"name":"Parametric"}],"servers":[{"url":"https://openapi.archisketch.com"}],"security":[{"open-api-key":[]}],"paths":{"/api/v1/parametric/components/{componentId}/parameters":{"post":{"tags":["Parametric"],"summary":"Create Component Parameters","description":"Creates parameters in a parametric component.","operationId":"createComponentParameters","parameters":[{"name":"componentId","in":"path","description":"Component ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameter list to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentParametersCreateRequest"}}},"required":true},"responses":{"200":{"description":"All responses return 200 (including success and failure) (5xx is exposed only in error conditions)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseComponentParametersResponse"}}}}}}}}}
```

## Modify Parameter Information

> Modifies parameter information.

```json
{"openapi":"3.1.0","info":{"title":"Open API","version":"snapshot"},"tags":[{"name":"Parametric"}],"servers":[{"url":"https://openapi.archisketch.com"}],"security":[{"open-api-key":[]}],"paths":{"/api/v1/parametric/components/parameters/{parameterId}":{"post":{"tags":["Parametric"],"summary":"Modify Parameter Information","description":"Modifies parameter information.","operationId":"modifyParameterInfo","parameters":[{"name":"parameterId","in":"path","description":"Parameter ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameter information to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyParameterRequest"}}},"required":true},"responses":{"200":{"description":"All responses return 200 (including success and failure) (5xx is exposed only in error conditions)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseUnit"}}}}}}}}}
```

## Delete Single Parameter

> Deletes a single parameter.

```json
{"openapi":"3.1.0","info":{"title":"Open API","version":"snapshot"},"tags":[{"name":"Parametric"}],"servers":[{"url":"https://openapi.archisketch.com"}],"security":[{"open-api-key":[]}],"paths":{"/api/v1/parametric/components/parameters/{parameterId}":{"delete":{"tags":["Parametric"],"summary":"Delete Single Parameter","description":"Deletes a single parameter.","operationId":"deleteParameter","parameters":[{"name":"parameterId","in":"path","description":"Parameter ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"All responses return 200 (including success and failure) (5xx is exposed only in error conditions)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponseUnit"}}}}}}}}}
```