Skip to main content

Inspect a file

PATCH 

/v1/files/:id

Queues inspection of an uploaded file — listing its solid bodies — and returns a job. Wait for the job with Stream job updates (GET /v1/jobs/{id}/events), then read the bodies with Get a file (GET /v1/files/{id}). A file holding no solid body fails the job, its error beginning no_solid_bodies:. A file is inspected once: once its bodies are listed they never change, and a further inspection is refused. A failed inspection lists nothing, so it can be run again. One inspection of a file runs at a time: another, while one is queued or running, is refused.

Experimental. Available now and still gaining functionality. It may change in breaking ways in a minor API release; each such change is listed in the release notes, so check them before upgrading.

Request​

Responses​

The inspection job was accepted; wait for it on GET /v1/jobs/{id}/events, then read /v1/files/{id}.