Browse all documentation

MODEL GUIDES

Fit checks

Use task_type fit with primary and secondary object ids to test whether one object can fit with another object or container.

What it answers

Can this object fit with, or inside, that one — and by how much clearance?

task_type: fit

What to send

input.object_idstring

The object being placed or checked.

input.secondary_idstring

The container, mating part, or envelope.

input.cad_sceneobject

Structured geometry containing both ids. point_cloud_scene also works.

Every field on the request schema is still accepted; these are the ones this task depends on.

What comes back

fit_result.fits

Boolean verdict for the pair.

fit_result.clearance

Measured gap, in the units of the scene.

fit_result.blocking

Which faces or entities cause a failure.

Example

Terminal
$ curl https://fourechelon.com/api/v1/responses \
-H "Authorization: Bearer $FOUR_ECHELON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
$ "model": "rowe-1.0",
$ "input": {
$ "task_type": "fit",
$ "object_id": "bracket",
$ "secondary_id": "housing",
$ "cad_scene": { "schema": "four-cad.cad_scene.v1", "solids": [] }
$ }
$ }'

Worth knowing

Clearance is reported as a number, not an adjective. If you need a pass/fail gate, threshold the measurement yourself so the tolerance lives in your code and is auditable.