{ "openapi": "3.1.0", "info": { "title": "SketchForge REST API v1 (contracted subset)", "version": "1", "description": "Generated from the runtime-facing API operation registry. This document contains only operations whose request, query, and response metadata can be represented accurately. The only omitted operations are the four preflight-only OPTIONS handlers listed in x-sketchforge-omitted-operations." }, "paths": { "/api/v1/booleans": { "post": { "operationId": "booleanShapes", "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shape", "triangles", "revision" ], "properties": { "shape": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } }, "triangles": { "type": "integer", "minimum": 0 }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Subtract one or more cutter shapes, including helical thread meshes, from solids and persist exact geometry. Kernel geometry failures return 422 geometry_failed.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "solidIds", "holeIds" ], "properties": { "solidIds": { "oneOf": [ { "type": "string", "pattern": "\\S" }, { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "\\S" } } ] }, "holeIds": { "oneOf": [ { "type": "string", "pattern": "\\S" }, { "type": "array", "minItems": 1, "items": { "type": "string", "pattern": "\\S" } } ] } }, "additionalProperties": true } } } } } }, "/api/v1/align": { "post": { "operationId": "alignShapes", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "moved", "axis", "target", "anchorId", "shapes", "revision" ], "properties": { "moved": { "type": "integer", "minimum": 0 }, "axis": { "type": "string", "enum": [ "x", "y", "z" ] }, "target": { "type": "string", "enum": [ "min", "center", "max" ] }, "anchorId": { "type": [ "string", "null" ] }, "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Align selected shapes by a shared minimum, centre, or maximum coordinate.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "axis", "target" ], "properties": { "ids": { "oneOf": [ { "type": "string", "pattern": "\\S", "description": "One non-empty shape ID." }, { "type": "array", "minItems": 1, "description": "Distinct non-empty shape IDs; surrounding whitespace is trimmed.", "items": { "type": "string", "pattern": "\\S" } } ] }, "axis": { "type": "string", "enum": [ "x", "y", "z" ] }, "target": { "type": "string", "enum": [ "min", "center", "max" ] }, "anchorId": { "type": "string", "description": "Optional reference shape ID; empty or whitespace is treated as omitted." } }, "additionalProperties": true } } } } } }, "/api/v1/distribute": { "post": { "operationId": "distributeShapes", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "moved", "axis", "spacing", "shapes", "revision" ], "properties": { "moved": { "type": "integer", "minimum": 0 }, "axis": { "type": "string", "enum": [ "x", "z" ] }, "spacing": { "type": "string", "enum": [ "gaps", "centers" ] }, "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Evenly space three or more selected shapes while keeping the outermost shapes fixed.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "oneOf": [ { "type": "string", "pattern": "\\S", "description": "One non-empty shape ID." }, { "type": "array", "minItems": 1, "description": "Distinct non-empty shape IDs; surrounding whitespace is trimmed.", "items": { "type": "string", "pattern": "\\S" } } ] }, "axis": { "type": "string", "enum": [ "x", "z" ], "description": "Omit to choose the axis along which the shapes are already most spread." }, "spacing": { "type": "string", "enum": [ "gaps", "centers" ], "default": "gaps" } }, "additionalProperties": true } } } } } }, "/api/v1/draft-prism": { "post": { "operationId": "draftPrism", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shape", "triangles", "revision" ], "properties": { "shape": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } }, "triangles": { "type": "integer", "minimum": 0 }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Draft an extruded shape along its vertical axis by an angle between -45 and 45 degrees, excluding zero.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "angle" ], "properties": { "angle": { "oneOf": [ { "type": "number", "maximum": 45, "exclusiveMinimum": 0 }, { "type": "number", "minimum": -45, "exclusiveMaximum": 0 } ] } }, "additionalProperties": true } } } } } }, "/api/v1/edges": { "get": { "operationId": "listEdges", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "edges" ], "properties": { "edges": { "type": "array", "items": { "type": "object", "required": [ "index", "length", "curveType", "midpoint", "filletable" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Zero-based position used by fillet and chamfer requests." }, "length": { "type": "number", "minimum": 0 }, "curveType": { "type": "string", "description": "Curve kind reported by the CAD kernel, or unknown when unavailable." }, "midpoint": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } }, "additionalProperties": false }, "filletable": { "type": "boolean", "description": "Whether the edge has two adjacent faces and can be treated." } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Lists the shape's edges in the index order used by fillet and chamfer requests; indexes can change when topology changes.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "description": "Whitespace is trimmed before validation. ID starts with a letter or digit and contains only letters, digits, underscores, and hyphens.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "description": "Whitespace is trimmed; the remaining value must not be empty.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/api/v1/explode": { "post": { "operationId": "explodeAssembly", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shapes", "revision" ], "properties": { "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } }, "additionalProperties": false } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "project_busy", "shape_locked", "revision_mismatch" ] }, "revision": { "type": "number" } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Explode an imported STEP assembly into editable product groups and exact component solids.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ] } }, "/api/v1/exports": { "post": { "operationId": "exportProject", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "filename", "mimeType", "bytes", "shapeCount", "base64" ], "properties": { "format": { "type": "string", "enum": [ "stl", "obj", "3mf", "step", "skf", "zip", "svg", "dxf" ] }, "filename": { "type": "string" }, "mimeType": { "type": "string" }, "shapeCount": { "type": "integer", "minimum": 0 }, "exportedCount": { "type": "integer", "minimum": 0 }, "skipped": { "type": "array", "items": { "type": "object", "required": [ "name", "kind", "reason" ], "properties": { "name": { "type": "string" }, "kind": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false } }, "bytes": { "type": "integer", "minimum": 0 }, "base64": { "type": "string" } }, "additionalProperties": false } }, "model/stl": { "schema": { "type": "string", "format": "binary" } }, "text/plain": { "schema": { "type": "string", "format": "binary" } }, "model/3mf": { "schema": { "type": "string", "format": "binary" } }, "model/step": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.sketchforge.project+zip": { "schema": { "type": "string", "format": "binary" } }, "application/zip": { "schema": { "type": "string", "format": "binary" } }, "image/svg+xml": { "schema": { "type": "string", "format": "binary" } }, "application/dxf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-SketchForge-Metadata": { "description": "URI-encoded JSON containing the export metadata fields (format, filename, mimeType, shapeCount, and optional STEP skipped-shape details).", "schema": { "type": "string" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_body", "unsupported_format", "invalid_request" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "limit_exceeded" ] }, "limit": { "type": "integer" }, "given": { "type": "integer" } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "geometry_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Export project geometry as JSON/base64, or return the raw artifact when download=1. Binary downloads carry result metadata in the X-SketchForge-Metadata response header. Section size caps return 413 limit_exceeded; geometry failures return 422.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "download", "in": "query", "required": false, "description": "Set download=1 to return raw artifact bytes; omitted or any other value returns JSON with base64 content.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "format" ], "properties": { "format": { "type": "string", "enum": [ "stl", "obj", "3mf", "step", "skf", "zip", "svg", "dxf" ] }, "shapeIds": { "oneOf": [ { "type": "string", "pattern": "\\S", "description": "A single non-empty shape ID is accepted as shorthand." }, { "type": "array", "uniqueItems": true, "description": "IDs are trimmed and must be distinct after trimming.", "items": { "type": "string", "pattern": "\\S" } } ] }, "name": { "type": "string", "maxLength": 120, "description": "Optional output basename; an empty or omitted value uses the project name." }, "view": { "type": "string", "enum": [ "multiview", "front", "back", "top", "bottom", "left", "right", "iso" ], "description": "SVG only; section and view are mutually exclusive." }, "featureAngle": { "type": "number", "minimum": 0, "maximum": 180, "description": "SVG projection only: crease angle in degrees for mesh shapes. An edge between two triangles is drawn only where they meet at more than this, besides boundaries and silhouettes. Defaults to 30; exact solids ignore it." }, "section": { "type": "object", "required": [ "plane", "offset" ], "description": "SVG or DXF only; section and view are mutually exclusive.", "properties": { "plane": { "type": "string", "enum": [ "xy", "xz", "yz" ] }, "offset": { "type": "number", "minimum": -100000, "maximum": 100000, "description": "Finite section-plane coordinate in millimetres." } }, "additionalProperties": true } }, "additionalProperties": true } } } } } }, "/api/v1/faces": { "get": { "operationId": "listFaces", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "faces" ], "properties": { "faces": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "surfaceType", "area", "centroid", "normal", "facing" ], "properties": { "index": { "type": "integer", "minimum": 0, "description": "Zero-based index used by shell requests." }, "id": { "type": "string", "description": "Application-owned face ID; use it as the faceColors key in PATCH /api/v1/shapes." }, "surfaceType": { "type": "string", "description": "Surface kind reported by the CAD kernel, or unknown when unavailable." }, "area": { "type": "number", "minimum": 0 }, "centroid": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } }, "additionalProperties": false }, "normal": { "type": [ "object", "null" ], "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } }, "additionalProperties": false }, "facing": { "type": [ "string", "null" ], "enum": [ "top", "bottom", "right", "left", "front", "back", null ] } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id", "invalid_request" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Lists each face with its shell-request index and stable application-owned ID. Use topology=exact to list analytic faces on supported plain full-turn sketch revolves without changing the default mesh listing. Face IDs can be used as faceColors keys in PATCH /api/v1/shapes.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "description": "Whitespace is trimmed before validation. ID starts with a letter or digit and contains only letters, digits, underscores, and hyphens.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "description": "Whitespace is trimmed; the remaining value must not be empty.", "schema": { "type": "string", "minLength": 1 } }, { "name": "topology", "in": "query", "required": false, "description": "Optional. Use exact to list analytic B-rep faces on a supported plain full-turn sketch revolve; the default mesh listing keeps its existing indexes.", "schema": { "type": "string", "pattern": "^(mesh|exact)$" } } ] } }, "/api/v1/groups": { "post": { "operationId": "groupShapes", "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shape", "revision" ], "properties": { "shape": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } }, "revision": { "type": "number" } }, "additionalProperties": false } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Groups at least two distinct shapes; members marked hole, including helical thread meshes, are subtracted using the same semantics as the editor. Kernel geometry failures return 422 geometry_failed.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "oneOf": [ { "type": "string", "pattern": "\\S", "description": "A single ID is accepted as shorthand, though grouping requires at least two shapes." }, { "type": "array", "minItems": 2, "uniqueItems": true, "description": "IDs are trimmed and must be distinct after trimming.", "items": { "type": "string", "pattern": "\\S" } } ] } } } } } } }, "delete": { "operationId": "ungroupShape", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shapes", "revision" ], "properties": { "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } }, "additionalProperties": false } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Ungroups a group and returns its children with the group's current transforms applied.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ] } }, "/api/v1/imports": { "post": { "operationId": "importGeometry", "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shape", "triangles", "revision" ], "properties": { "shape": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } }, "triangles": { "type": "integer" }, "revision": { "type": "number" } }, "additionalProperties": false } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_body", "invalid_request" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found" ] } }, "additionalProperties": false } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "project_busy", "revision_mismatch" ] }, "revision": { "type": "number" } }, "additionalProperties": false } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "limit_exceeded" ] }, "limit": { "type": "integer" }, "given": { "type": "integer" } }, "additionalProperties": false } } } }, "415": { "description": "Response declared by the operation contract.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unsupported_format" ] } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "geometry_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Imports an STL, OBJ, or SVG file from base64 JSON or multipart form data, stores the source asset, and returns the imported mesh summary. Requests and decoded files are size-limited and return 413 limit_exceeded when over the supported limit.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fileName" ], "properties": { "fileName": { "type": "string", "minLength": 1, "pattern": "\\S", "description": "File name is trimmed, selects the importer, and names the stored asset." }, "data": { "type": "string", "minLength": 1, "description": "Base64-encoded file bytes. Takes precedence over contents when both are sent." }, "contents": { "type": "string", "minLength": 1, "description": "Alias for data; used when data is absent." }, "mediaType": { "type": "string" } }, "anyOf": [ { "type": "object", "required": [ "data" ] }, { "type": "object", "required": [ "contents" ] } ], "additionalProperties": true } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "description": "The uploaded model file.", "format": "binary" }, "fileName": { "type": "string", "minLength": 1, "pattern": "\\S", "description": "Optional trimmed importer name override; defaults to the uploaded file name." } }, "additionalProperties": true } } } } } }, "/api/v1/interference": { "post": { "operationId": "analyzeInterference", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shapesChecked", "candidatePairsChecked", "clearance", "method", "pairs" ], "properties": { "shapesChecked": { "type": "integer", "minimum": 0 }, "candidatePairsChecked": { "type": "integer", "minimum": 0 }, "clearance": { "type": "number", "minimum": 0 }, "method": { "type": "string", "enum": [ "OCCT exact distance and common volume; AABB candidate prefilter" ] }, "pairs": { "type": "array", "items": { "type": "object", "required": [ "a", "b", "gap", "overlapVolume", "precision" ], "properties": { "a": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "b": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "gap": { "type": "number", "minimum": 0 }, "overlapVolume": { "type": "number", "minimum": 0 }, "precision": { "type": "string", "enum": [ "exact", "tessellated" ] } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "limit_exceeded" ] }, "limit": { "type": "integer" }, "given": { "type": "integer" } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Reports exact gaps and overlap volumes for visible, non-cutter shapes, subject to 128-shape and 512-candidate limits. Exceeding either cap returns 413 limit_exceeded.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "oneOf": [ { "type": "string", "pattern": "\\S", "description": "Whitespace is trimmed; IDs must be unique after trimming." }, { "type": "array", "minItems": 1, "description": "IDs are trimmed and must be unique after trimming.", "items": { "type": "string", "pattern": "\\S" } } ] }, "clearance": { "type": "number", "minimum": 0, "description": "Maximum exact surface gap in millimetres; defaults to zero." } }, "additionalProperties": true } } } } } }, "/api/v1/measurements": { "get": { "operationId": "listMeasurements", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "measurements" ], "properties": { "measurements": { "type": "array", "items": { "type": "object", "required": [ "entity", "index", "geometryType", "length", "area", "radius", "diameter", "sweepDegrees", "radiusUnavailable" ], "properties": { "entity": { "type": "string", "enum": [ "edge", "face" ] }, "index": { "type": "integer", "minimum": 0 }, "geometryType": { "type": "string" }, "length": { "type": [ "number", "null" ] }, "area": { "type": [ "number", "null" ] }, "radius": { "type": [ "number", "null" ] }, "diameter": { "type": [ "number", "null" ] }, "sweepDegrees": { "type": [ "number", "null" ] }, "radiusUnavailable": { "type": [ "string", "null" ], "enum": [ "notCircular", "ellipseHasNoSingleRadius", "degenerateCurve", "notCurved", "radiusVariesOverSurface", "radiusNotReportedByKernel", "degenerateSurface", null ] } } } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "project_busy", "revision_mismatch" ] }, "revision": { "type": "number" } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "description": "Whitespace is trimmed before validation. ID starts with a letter or digit and contains only letters, digits, underscores, and hyphens.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "description": "Whitespace is trimmed; the remaining value must not be empty.", "schema": { "type": "string", "minLength": 1 } } ] }, "post": { "operationId": "measureEntities", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "distance", "angleDegrees", "angleUnavailable" ], "properties": { "distance": { "type": "number", "minimum": 0 }, "angleDegrees": { "type": "number", "minimum": 0, "maximum": 180 }, "angleUnavailable": { "type": [ "string", "null" ], "enum": [ null ] } } }, { "type": "object", "required": [ "distance", "angleDegrees", "angleUnavailable" ], "properties": { "distance": { "type": "number", "minimum": 0 }, "angleDegrees": { "type": [ "number", "null" ], "enum": [ null, null ] }, "angleUnavailable": { "type": "string", "enum": [ "notPlanar", "degenerateNormal" ] } } } ] } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_body", "invalid_request" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "project_busy", "revision_mismatch" ] }, "revision": { "type": "number" } }, "additionalProperties": false } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "oneOf": [ { "type": "object", "not": { "type": "object", "required": [ "entity" ] }, "required": [ "shapeId" ], "properties": { "shapeId": { "type": "string", "pattern": "\\S", "description": "Whitespace is trimmed; the remaining value must not be empty." } } }, { "type": "object", "required": [ "shapeId", "entity" ], "properties": { "shapeId": { "type": "string", "pattern": "\\S" }, "entity": { "type": "string", "enum": [ "shape" ] } } }, { "type": "object", "required": [ "shapeId", "entity", "index" ], "properties": { "shapeId": { "type": "string", "pattern": "\\S" }, "entity": { "type": "string", "enum": [ "edge", "face" ] }, "index": { "type": "integer", "minimum": 0, "description": "Zero-based edge or face index." } } } ] }, "to": { "oneOf": [ { "type": "object", "not": { "type": "object", "required": [ "entity" ] }, "required": [ "shapeId" ], "properties": { "shapeId": { "type": "string", "pattern": "\\S", "description": "Whitespace is trimmed; the remaining value must not be empty." } } }, { "type": "object", "required": [ "shapeId", "entity" ], "properties": { "shapeId": { "type": "string", "pattern": "\\S" }, "entity": { "type": "string", "enum": [ "shape" ] } } }, { "type": "object", "required": [ "shapeId", "entity", "index" ], "properties": { "shapeId": { "type": "string", "pattern": "\\S" }, "entity": { "type": "string", "enum": [ "edge", "face" ] }, "index": { "type": "integer", "minimum": 0, "description": "Zero-based edge or face index." } } } ] } } } } } } } }, "/api/v1/mirrors": { "post": { "operationId": "mirrorShapes", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "moved", "axis", "shapes", "revision" ], "properties": { "moved": { "type": "integer", "minimum": 0 }, "axis": { "type": "string", "enum": [ "x", "y", "z" ] }, "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } }, "additionalProperties": false } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Mirrors selected shapes across the principal plane through the midpoint of their combined bounds.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "axis" ], "properties": { "ids": { "oneOf": [ { "type": "string", "pattern": "\\S", "description": "A single shape ID; whitespace is trimmed before lookup." }, { "type": "array", "minItems": 1, "uniqueItems": true, "description": "Distinct shape IDs; whitespace is trimmed before lookup.", "items": { "type": "string", "pattern": "\\S" } } ] }, "axis": { "type": "string", "enum": [ "x", "y", "z" ], "description": "Principal plane normal to this coordinate axis." } }, "additionalProperties": true } } } } } }, "/api/v1/parts": { "post": { "operationId": "splitParts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shapes", "revision" ], "properties": { "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } }, "additionalProperties": false } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "project_busy", "shape_locked", "revision_mismatch" ] }, "revision": { "type": "number" } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_request", "geometry_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Split a shape into its separate bodies or restore a plain group to its member shapes.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ] } }, "/api/v1/patterns": { "post": { "operationId": "patternShapes", "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "created", "kind", "shapes", "revision" ], "properties": { "created": { "type": "integer", "minimum": 0 }, "kind": { "type": "string", "enum": [ "linear", "circular" ] }, "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_body", "invalid_request" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "project_busy", "revision_mismatch" ] }, "revision": { "type": "number" } }, "additionalProperties": false } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "limit_exceeded" ] }, "limit": { "type": "integer" }, "given": { "type": "integer" } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Create linear or circular copies of selected shapes.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "oneOf": [ { "type": "string", "pattern": "\\S" }, { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "pattern": "\\S" } } ] }, "kind": { "type": "string", "enum": [ "linear", "circular" ], "default": "linear" }, "count": { "type": [ "integer", "null" ], "default": 4, "minimum": 2, "maximum": 200 }, "stepX": { "type": "number", "default": 0 }, "stepZ": { "type": "number", "default": 0 }, "centerX": { "type": "number", "default": 0 }, "centerZ": { "type": "number", "default": 0 }, "sweepAngle": { "type": "number", "default": 360 }, "rotateCopies": { "type": "boolean", "default": true, "description": "For circular patterns, rotate each copy to follow the ring; defaults to true." } } } } } } } }, "/api/v1/projects": { "get": { "operationId": "listProjectsOrGetProject", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "projects", "nextCursor" ], "properties": { "projects": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "shapes", "revision", "updatedAt", "packageBytes" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "shapes": { "type": "integer" }, "revision": { "type": "number" }, "updatedAt": { "type": "number" }, "packageBytes": { "type": "integer" } } } }, "nextCursor": { "type": [ "string", "null" ] } } }, { "type": "object", "required": [ "project" ], "properties": { "project": { "type": "object", "required": [ "id", "name", "createdAt", "snapGrid", "workspace", "shapes" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "number" }, "snapGrid": { "type": "string" }, "workspace": { "type": "object", "additionalProperties": true }, "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } } } } } } ] } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$", "maxLength": 128 } } ] }, "post": { "operationId": "createProject", "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "project" ], "properties": { "project": { "type": "object", "required": [ "id", "name", "shapes", "revision", "updatedAt", "packageBytes" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "shapes": { "type": "integer" }, "revision": { "type": "number" }, "updatedAt": { "type": "number" }, "packageBytes": { "type": "integer" } } } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 } } } } } } }, "delete": { "operationId": "deleteProject", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted", "id", "revision" ], "properties": { "deleted": { "type": "boolean" }, "id": { "type": "string" }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ] } }, "/api/v1/properties": { "get": { "operationId": "getShapeProperties", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "properties" ], "properties": { "properties": { "type": "object", "required": [ "volume", "area", "centerOfMass", "bbox", "isValid", "provenance" ], "properties": { "volume": { "type": "number" }, "area": { "type": "number" }, "centerOfMass": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } }, "additionalProperties": false }, "bbox": { "type": "object", "required": [ "xmin", "ymin", "zmin", "xmax", "ymax", "zmax" ], "properties": { "xmin": { "type": "number" }, "ymin": { "type": "number" }, "zmin": { "type": "number" }, "xmax": { "type": "number" }, "ymax": { "type": "number" }, "zmax": { "type": "number" } }, "additionalProperties": false }, "isValid": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "source", "precision" ], "properties": { "source": { "type": "string", "enum": [ "parametric", "brep", "mesh" ] }, "precision": { "type": "string", "enum": [ "exact", "tessellated" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Returns exact mass properties for the positioned shape and identifies whether the measurements came from exact CAD geometry or tessellated mesh geometry.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "description": "Whitespace is trimmed before validation. ID starts with a letter or digit and contains only letters, digits, underscores, and hyphens.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "description": "Whitespace is trimmed; the remaining value must not be empty.", "schema": { "type": "string", "minLength": 1 } } ] } }, "/api/v1/shapes": { "get": { "operationId": "listShapes", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shapes", "nextCursor" ], "properties": { "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^\\d{1,4}$", "maxLength": 4 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$", "maxLength": 128 } } ] }, "post": { "operationId": "createShapes", "responses": { "201": { "description": "Resource created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shapes", "revision" ], "properties": { "shapes": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } } }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "kind" ], "properties": { "kind": { "type": "string" }, "profile": { "oneOf": [ { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } ] } }, "additionalProperties": true }, { "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "type": "string" }, "profile": { "oneOf": [ { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } ] } }, "additionalProperties": true } } }, "additionalProperties": false } ] } } } } }, "patch": { "operationId": "updateShape", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shape", "revision" ], "properties": { "shape": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "project_busy", "shape_locked", "revision_mismatch" ] }, "revision": { "type": "number" } }, "additionalProperties": false } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unapplicable_fields", "geometry_failed", "cad_failed" ] }, "fields": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "geometry_failed", "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "faceColors": { "type": "object", "patternProperties": { "^(?:[0-9]+|face_[^\\s]+)$": { "type": "string", "pattern": "^#[0-9a-fA-F]{6}(?:[0-9a-fA-F]{2})?$" } }, "additionalProperties": false } }, "additionalProperties": true } } } } }, "delete": { "operationId": "deleteShape", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted", "id", "revision" ], "properties": { "deleted": { "type": "boolean" }, "id": { "type": "string" }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ] } }, "/api/v1/shell": { "post": { "operationId": "shellShape", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shape", "triangles", "revision" ], "properties": { "shape": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } }, "triangles": { "type": "integer", "minimum": 0 }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Hollow a shape to a specified wall thickness, optionally leaving selected faces open.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "thickness" ], "properties": { "thickness": { "type": "number", "exclusiveMinimum": 0 }, "openFaces": { "oneOf": [ { "type": [ "string", "null" ] }, { "type": "number" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } } ] } }, "additionalProperties": true } } } } } }, "/api/v1/thickness": { "get": { "operationId": "estimateThickness", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "thickness" ], "properties": { "thickness": { "type": "object", "required": [ "minimum", "unit", "method", "samplesPerFace", "facesChecked" ], "properties": { "minimum": { "type": [ "number", "null" ], "minimum": 0 }, "unit": { "type": "string", "enum": [ "mm" ] }, "method": { "type": "string", "enum": [ "sampled-opposing-surface-distance" ] }, "samplesPerFace": { "type": "integer", "minimum": 1 }, "facesChecked": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "invalid_project_id", "invalid_shape_id" ] } }, "additionalProperties": false } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "unauthorized" ] } }, "additionalProperties": false } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "project_not_found", "shape_not_found" ] } }, "additionalProperties": false } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "limit_exceeded" ] }, "limit": { "type": "integer" }, "given": { "type": "integer" } }, "additionalProperties": false } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "geometry_failed" ] } }, "additionalProperties": false } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "cad_failed", "internal_error" ] } }, "additionalProperties": false } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "storage_unconfigured" ] } }, "additionalProperties": false } } } } }, "description": "Estimates minimum wall thickness by sampling opposing surface pairs; this is not a certified minimum-thickness result.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } } ] } }, "/api/v1/treatments": { "post": { "operationId": "treatShape", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "shape", "triangles", "revision" ], "properties": { "shape": { "type": "object", "required": [ "id", "name", "kind", "color", "hole", "locked", "hidden", "x", "z", "elevation", "width", "depth", "rotation", "rotationX", "rotationZ" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "requestKind": { "type": "string" }, "sketchOperation": { "type": "string" }, "sketchSourceId": { "type": "string" }, "draftPrismAngle": { "type": "number" }, "faceDraft": { "type": "object", "required": [ "sourceFaceId", "angle", "pullDirection", "sourceFaceNormal" ], "properties": { "sourceFaceId": { "type": "string" }, "angle": { "type": "number" }, "pullDirection": { "type": "string", "enum": [ "x", "y", "z", "-x", "-y", "-z" ] }, "sourceFaceNormal": { "type": "object", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "z": { "type": "number" } } } } }, "sketchProfile": { "type": "object", "required": [ "points", "segments" ], "properties": { "points": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "segments": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "sweepFrames": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "color": { "type": "string" }, "faceIds": { "type": "array", "items": { "type": "string" } }, "faceColors": { "type": "object", "additionalProperties": { "type": "string" } }, "stepAssembly": { "type": "array", "description": "Optional STEP product hierarchy metadata. Imported geometry remains one mesh until exploded.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 2000, "description": "Direct product children; hierarchy depth is capped at 32.", "items": { "type": "object", "required": [ "name", "children" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "children": { "type": "array", "maxItems": 0, "description": "Direct product children; hierarchy depth is capped at 32." } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "additionalProperties": false } }, "stepComponent": { "type": "object", "required": [ "id", "occurrenceId", "path" ], "description": "STEP source occurrence identity and root-to-component ancestry for a selectable exploded solid.", "properties": { "id": { "type": "string" }, "occurrenceId": { "type": "string" }, "path": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "hole": { "type": "boolean" }, "locked": { "type": "boolean" }, "hidden": { "type": "boolean" }, "x": { "type": "number" }, "z": { "type": "number" }, "elevation": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "height": { "type": "number" }, "rotation": { "type": "number" }, "rotationX": { "type": "number" }, "rotationZ": { "type": "number" }, "groupedCount": { "type": "integer" }, "revolve": { "type": "object", "additionalProperties": true }, "profile": { "type": "array", "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number" } } } } }, "triangles": { "type": "integer", "minimum": 0 }, "revision": { "type": "number" } } } } }, "headers": { "ETag": { "description": "The project revision after this write.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "401": { "description": "Authentication failed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "404": { "description": "Resource not found or API disabled.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "409": { "description": "The project is busy or the request conflicts with current state.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "413": { "description": "Request exceeds the supported size or item limit.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "422": { "description": "Request is valid JSON but cannot be applied.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "500": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } }, "503": { "description": "Server-side failure.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string" }, "code": { "type": "string", "enum": [ "api_disabled", "unauthorized", "storage_unconfigured", "invalid_project_id", "invalid_shape_id", "invalid_body", "invalid_request", "project_not_found", "project_exists", "project_busy", "revision_mismatch", "shape_not_found", "shape_locked", "unsupported_kind", "unsupported_format", "unapplicable_fields", "too_many_shapes", "limit_exceeded", "geometry_failed", "cad_failed", "internal_error" ] }, "revision": { "type": "number" } }, "additionalProperties": true } } } } }, "description": "Apply a fillet or chamfer to all edges or selected edge indexes.", "security": [ { "bearerAuth": [] }, { "sketchForgeToken": [] } ], "parameters": [ { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "maxLength": 120 } }, { "name": "shapeId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "If-Match", "in": "header", "required": false, "description": "Apply this write only when the project still has the quoted revision returned by a previous write. A mismatch returns 409 revision_mismatch with the current revision.", "schema": { "type": "string", "pattern": "^\\\"[0-9]+\\\"$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "kind", "amount" ], "properties": { "kind": { "type": "string", "enum": [ "fillet", "chamfer" ] }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "angle": { "type": "number" }, "edges": { "oneOf": [ { "type": "string", "enum": [ "all" ] }, { "type": [ "array", "null" ], "items": { "type": "number" } } ] } }, "additionalProperties": true } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" }, "sketchForgeToken": { "type": "apiKey", "in": "header", "name": "X-SketchForge-Token" } } }, "x-sketchforge-source": "apps/web/src/lib/apiV1OperationContract.ts", "x-sketchforge-omitted-operations": [ { "method": "OPTIONS", "path": "/api/v1/edges", "operationId": "edgeRouteOptions", "reason": "Preflight-only operation; omitted from the resource API document." }, { "method": "OPTIONS", "path": "/api/v1/faces", "operationId": "faceRouteOptions", "reason": "Preflight-only operation; omitted from the resource API document." }, { "method": "OPTIONS", "path": "/api/v1/properties", "operationId": "propertyRouteOptions", "reason": "Preflight-only operation; omitted from the resource API document." }, { "method": "OPTIONS", "path": "/api/v1/thickness", "operationId": "thicknessRouteOptions", "reason": "Preflight-only operation; omitted from the resource API document." } ] }