Modeling

Create Modeling

post

Creates modeling by uploading a file.

Authorizations

open-api-key

Query parameters

isPersonalbooleanOptional

Personal library status

startModelingbooleanOptional

Start rendering immediately status

Body

multipart/form-data

namestringRequired

Modeling name

filestring · binaryRequired

Modeling file

Responses

200

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

application/json

anyOptional

post/api/v1/modelings

HTTPcURLJavaScriptPython

POST /api/v1/modelings HTTP/1.1
Host: openapi.archisketch.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 31

{
  "name": "text",
  "file": "binary"
}

200

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

No content

Change Modeling File

patch

Changes the original file of the modeling.

Authorizations

open-api-key

Path parameters

idstringRequired

Modeling ID

Query parameters

startModelingbooleanOptional

Start rendering immediately status

Body

multipart/form-data

filestring · binaryRequired

New modeling file

Responses

200

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

application/json

anyOptional

patch/api/v1/modelings/{id}/file

HTTPcURLJavaScriptPython

PATCH /api/v1/modelings/{id}/file HTTP/1.1
Host: openapi.archisketch.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

200

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

No content

Get Modeling

get

Authorizations

open-api-key

Path parameters

idstringRequired

Modeling ID

Responses

200

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

application/json

anyOptional

get/api/v1/modelings/{id}

HTTPcURLJavaScriptPython

GET /api/v1/modelings/{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