GET /api/v1/thickness

operationId: estimateThickness

Estimates minimum wall thickness by sampling opposing surface pairs; this is not a certified minimum-thickness result.

Authentication

Provide either authentication method:

• Bearer token (Authorization: Bearer <token>).
• API token in the X-SketchForge-Token header.

Parameters

Name	In	Required	Schema	Description
projectId	query	Yes	{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","maxLength":120}	—
shapeId	query	Yes	{"type":"string","minLength":1}	—

Request body

No request body.

Responses

200 — Successful response.

Content type: application/json

{
  "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 — Invalid request.

Content type: application/json

{
  "type": "object",
  "required": [
    "error",
    "code"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "invalid_project_id",
        "invalid_shape_id"
      ]
    }
  },
  "additionalProperties": false
}

401 — Authentication failed.

Content type: application/json

{
  "type": "object",
  "required": [
    "error",
    "code"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "unauthorized"
      ]
    }
  },
  "additionalProperties": false
}

404 — Resource not found or API disabled.

Content type: application/json

{
  "type": "object",
  "required": [
    "error",
    "code"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "api_disabled",
        "project_not_found",
        "shape_not_found"
      ]
    }
  },
  "additionalProperties": false
}

413 — Request exceeds the supported size or item limit.

Content type: application/json

{
  "type": "object",
  "required": [
    "error",
    "code"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "limit_exceeded"
      ]
    },
    "limit": {
      "type": "integer"
    },
    "given": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

422 — Request is valid JSON but cannot be applied.

Content type: application/json

{
  "type": "object",
  "required": [
    "error",
    "code"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "geometry_failed"
      ]
    }
  },
  "additionalProperties": false
}

500 — Server-side failure.

Content type: application/json

{
  "type": "object",
  "required": [
    "error",
    "code"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "cad_failed",
        "internal_error"
      ]
    }
  },
  "additionalProperties": false
}

503 — Server-side failure.

Content type: application/json

{
  "type": "object",
  "required": [
    "error",
    "code"
  ],
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "storage_unconfigured"
      ]
    }
  },
  "additionalProperties": false
}

Source

Route handler source · OpenAPI JSON · REST API guide

---

Documentation version: 1.30.0 · Repository revision: 1cb9fee8dff4d394684c229dd67a21da539d167f · View source