API documentation
Everything you need for the integration of Werk24: installation, endpoints, inquiries and sample answers - developed for quick, reliable automation of technical drawings.
You can find that in the docs
- Installation: How to add the Werk24 client and receive a test key.
- Cli requests: Send drawings directly from the terminal for fast tests.
- API requests: Code examples for API calls via Python or HTTPS.
- API reference: End point definitions, parameters and sample answers.
- Troubleshooting & restrictions: Statuscodes, troubleshooting, supported formats.
- FAQs: Answers to frequent setup and integration questions.
Quick start
Python client example-extract metadata, features and insights:
from werk24 import read_drawing_sync, get_test_drawing, AskMetaData
print(read_drawing_sync(get_test_drawing(), [AskMetaData()]))What the API returns
All responses are JSON. Typical Asks include Metadata , features , insights , Redaction balloons .
MetaData
{
"ask_version": "v2",
"ask_type": "META_DATA",
"page_type": "COMPONENT_DRAWING",
"identifiers": [
{
"reference_id": 0,
"language": null,
"value": "WK2401",
"identifier_type": "DRAWING_NUMBER",
"stakeholder": null,
"period": null
}
],
"designation": [
{
"reference_id": 1,
"language": null,
"value": "ADAPTER"
}
],
"languages": [
"ENG"
],
"general_tolerances": null,
"general_roughness": {
"reference_id": 2,
"label": "\u221a",
"confidence": null,
"standard": "ISO 1302:2002",
"machining_allowance": null,
"material_removal_type": "UNSPECIFIED",
"applies_all_around": false,
"direction_of_lay": null,
"manufacturing_process": "",
"conditions": [],
"waviness": null
},
"material_options": [
{
"reference_id": 3,
"material_combination": [
{
"raw_ocr": "20MnCr5",
"standard": "DIN EN 10084",
"designation": "20MnCr5",
"material_category": [
"FERROUS_ALLOY",
"STEEL",
"STRUCTURAL_OR_CONSTRUCTIONAL_STEEL"
]
}
]
}
],
"weight": {
"reference_id": 4,
"value": "1.025",
"unit": "kilogram"
},
"projection_method": {
"reference_id": 5,
"projection_method": "FIRST_ANGLE"
},
"bill_of_material": null,
"unit_systems": [
{
"reference_id": 6,
"unit_system_type": "METRIC"
}
]
}Features
{
"ask_version": "v2",
"ask_type": "FEATURES",
"page_type": "COMPONENT_DRAWING",
"dimensions": [
{
"reference_id": 0,
"label": "12 ±0.1",
"confidence": {
"score": "0.96"
},
"quantity": 1,
"size": {
"value": "12",
"unit": "mm",
"size_type": "LINEAR",
"tolerance": {
"tolerance_grade": "12",
"deviation_lower": "-0.1",
"deviation_upper": "0.1",
"fit": null,
"is_theoretically_exact": false,
"is_reference": false,
"is_general_tolerance": false,
"is_approximation": false
}
}
}
],
"threads": [
{
"reference_id": 1,
"label": "M5×0.8—6g/6H",
"thread_type": "ISO_METRIC",
"quantity": 1,
"diameter": "5",
"spacing": {
"pitch_in_mm": "0.8",
"threads_per_inch": "31.75"
},
"handedness": "RIGHT",
"depth": null,
"confidence": {
"score": 0.95
}
}
],
"bores": [
{
"reference_id": 2,
"label": "Ø6 H7 (+0.012/0) ↧13.4",
"quantity": 1,
"counterbore": null,
"countersink": null,
"counterdrill": null,
"diameter": {
"size_type": "DIAMETER",
"value": "6",
"tolerance": {
"deviation_lower": "0",
"deviation_upper": "0.012",
"tolerance_grade": "7",
"fit": "H7",
"is_theoretically_exact": false,
"is_reference": false,
"is_general_tolerance": false,
"is_approximation": false
},
"unit": "mm"
},
"depth": {
"depth_type": "SIZE",
"value": "13.4",
"tolerance": null,
"unit": "mm"
},
"thread": null,
"confidence": {
"score": 0.94
}
}
],
"chamfers": [
{
"reference_id": 3,
"label": "1 x 45°",
"quantity": 1,
"size": {
"size_type": "LINEAR",
"value": "1",
"tolerance": {
"deviation_lower": null,
"deviation_upper": null,
"tolerance_grade": null,
"fit": null,
"is_theoretically_exact": false,
"is_reference": false,
"is_general_tolerance": true,
"is_approximation": false
},
"unit": "mm"
},
"angle": {
"size_type": "ANGULAR",
"value": "45",
"tolerance": {
"deviation_lower": null,
"deviation_upper": null,
"tolerance_grade": null,
"fit": null,
"is_theoretically_exact": false,
"is_reference": false,
"is_general_tolerance": true,
"is_approximation": false
},
"unit": "degree"
}
}
],
"roughnesses": [
{
"reference_id": 4,
"label": "○√",
"confidence": {
"score": "1.00"
},
"standard": "ISO 1302:2002",
"machining_allowance": null,
"material_removal_type": "PROHIBITED",
"applies_all_around": false,
"direction_of_lay": null,
"manufacturing_process": "",
"conditions": [],
"waviness": null
}
],
"gdnts": [
{
"reference_id": 26,
"label": "[⟂|0.5|A]",
"confidence": {
"score": "0.98"
},
"characteristic": "⟂",
"zone": {
"value": {
"value": "0.5",
"unit": "mm",
"size_type": "LINEAR",
"tolerance": null
},
"extend": null,
"combination": null,
"offset": null,
"constraint": null
},
"feature": null,
"reference": null,
"material_condition": null,
"state": null,
"datums": [{ "label": "A" }]
}
],
"radii": [
{
"reference_id": 35,
"label": "R7 0/-0.5",
"confidence": {
"score": "0.96"
},
"quantity": 1,
"curvature_type": null,
"size": {
"value": "7",
"unit": "mm",
"size_type": "LINEAR",
"tolerance": {
"tolerance_grade": "14",
"deviation_lower": "-0.5",
"deviation_upper": "0",
"fit": null,
"is_theoretically_exact": false,
"is_reference": false,
"is_general_tolerance": false,
"is_approximation": false
}
}
}
]
}Insights
{
"ask_version": "v2",
"ask_type": "INSIGHTS",
"page_type": "COMPONENT_DRAWING",
"primary_process_options": [
{ "process": "TurningProcess", "requires_secondary_milling": true }
],
"secondary_processes": [
{
"reference_id": 1,
"label": "Anodizing",
"process_category": ["COATING", "COATING_FROM_IONDIZED_STATE", "GALVANIC_COATING", "ANODIZING"],
"confidence": { "score": 0.88 }
}
],
"volume_estimate": { "value": 125.6, "unit": "cm³", "confidence": { "score": 0.94 } }
}Complete references: MetaData · Features · Insights · Redaction · Balloons
Previous API version needed?
You can continue to call up the older documentation here: Legacy API Documentation.
Why Werk24?
- Seamless integration: SDK + HTTPS + webhooks that fit your stack.
- Extended functions: Meta, features, insights, redaction, balloons - especially for technical drawings.
- Developer -friendly: Deterministic JSON, Confidence Scores and clear documentation.