Make parts from a file
POST/v1/files/:id/parts
Makes a part of each named body of an inspected file. Each part is an ordinary part from then on: run Analyze a part (PATCH /v1/parts/{id}) and the rest of the pipeline on it, as on an uploaded one. Naming a body that is already a part returns that part rather than making another, so one call can make every part of a file, or calls can make them one at a time. Name only the bodies to machine. Each part comes back with the shape its body is (the file’s shapes), so a client can make one part of a shape and quote it by the shape’s count; nothing stops it making a part of every copy. The body a part is cut from is stated as stock with each part’s plan, not here.
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
- 201
- 400
- 401
- 403
- 404
- 409
- 410
- 500
- 503
The parts are ready to analyze.
The request is invalid, or names a body the file does not have.
The API key is missing or invalid.
The API key may not perform this operation: it has no access to this part of the API, it may only read it, or its creator has not met the organization’s two-factor requirement.
The file does not exist.
The file has not been inspected, or it changed after it was (file_source_changed).
The file is older than the retention window and is no longer available.
The parts could not be made.
Authentication is temporarily unavailable.