API Endpoint Reference / Partner production

Prepare plates of partner sources for an exact printer

Deprecated. Use Create a Slice job (POST /v1/slice-jobs) instead. This operation keeps working, and no removal date is set.

POST https://api.printhiv3d.com/v1/partner-production/preparations

Operation ID createPartnerPreparation. Requires the production:upload API key scope.

Creates a durable asynchronous preparation request. Each item names a source version or a partner externalId, plates ("all" or a list), a plate-run quantity, optional material mappings and guidance, and an exact qualified printer. Requires Idempotency-Key. Creates no print job.

Parameters

NameInTypeRequiredDescription
idempotency-keyheaderstringYes

Request body

Content type application/json.

FieldTypeRequiredDescription
allowUnqualifiedConversionbooleanNo
itemsobject[]Yes

Responses

StatusDescription
200Default Response
202Default Response
400Default Response
401Default Response
403Default Response
409Default Response
422Default Response
503Default Response

200 response fields

FieldTypeRequiredDescription
preparationIduuidYes
sliceJobIduuidYes
status"waiting_for_source" | "preparing" | "held" | "ready" | "failed"Yes
createdAtdate-timeYes
holdsobject[]Yes
itemsobject[]Yes

202 response fields

FieldTypeRequiredDescription
preparationIduuidYes
sliceJobIduuidYes
status"waiting_for_source" | "preparing" | "held" | "ready" | "failed"Yes
createdAtdate-timeYes
holdsobject[]Yes
itemsobject[]Yes

400 response fields

FieldTypeRequiredDescription
error"invalid_request" | "unauthorized" | "not_found" | "idempotency_conflict" | "output_not_ready" | "output_unavailable" | "request_too_large" | "source_not_found" | "target_not_found" | "target_not_qualified" | "material_not_qualified" | "preparation_disabled" | "preparation_unavailable"Yes
itemintegerNo
limitobjectNo
reasonsobject[]NoPresent on target_not_qualified: one entry for each refused item.

401 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

403 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo

409 response fields

FieldTypeRequiredDescription
error"invalid_request" | "unauthorized" | "not_found" | "idempotency_conflict" | "output_not_ready" | "output_unavailable" | "request_too_large" | "source_not_found" | "target_not_found" | "target_not_qualified" | "material_not_qualified" | "preparation_disabled" | "preparation_unavailable"Yes
itemintegerNo
limitobjectNo
reasonsobject[]NoPresent on target_not_qualified: one entry for each refused item.

422 response fields

FieldTypeRequiredDescription
error"invalid_request" | "unauthorized" | "not_found" | "idempotency_conflict" | "output_not_ready" | "output_unavailable" | "request_too_large" | "source_not_found" | "target_not_found" | "target_not_qualified" | "material_not_qualified" | "preparation_disabled" | "preparation_unavailable"Yes
itemintegerNo
limitobjectNo
reasonsobject[]NoPresent on target_not_qualified: one entry for each refused item.

503 response fields

FieldTypeRequiredDescription
error"invalid_request" | "unauthorized" | "not_found" | "idempotency_conflict" | "output_not_ready" | "output_unavailable" | "request_too_large" | "source_not_found" | "target_not_found" | "target_not_qualified" | "material_not_qualified" | "preparation_disabled" | "preparation_unavailable"Yes
itemintegerNo
limitobjectNo
reasonsobject[]NoPresent on target_not_qualified: one entry for each refused item.

Example 202 response

{
  "preparationId": "d8c5b2e9-4a7f-4e16-a3d0-9f2b6c1e8a47",
  "sliceJobId": "d8c5b2e9-4a7f-4e16-a3d0-9f2b6c1e8a47",
  "status": "ready",
  "createdAt": "2026-11-04T18:00:00.000Z",
  "holds": [],
  "items": [
    {
      "index": 0,
      "status": "ready",
      "source": {
        "sourceVersionId": "5f8a2c6e-9d1b-4e73-b4a0-2c7e9f1d6b85",
        "externalId": "storefront-product-1042",
        "status": "ready"
      },
      "plates": [
        1
      ],
      "resolvedPlates": [
        1
      ],
      "quantity": 1,
      "materialMappings": [],
      "guidance": {
        "allowedMaterials": [],
        "preferredFilaments": []
      },
      "target": {
        "printerId": "7d3f1c2a-5b8e-4f6a-9c1d-2e4b6a8c0f13",
        "printerName": "Bay 3",
        "printerModel": "P1S",
        "nozzleDiameterMm": 0.4,
        "nozzleFlow": "standard",
        "buildSurface": "Textured PEI Plate"
      },
      "failure": null,
      "preparedPlates": []
    }
  ]
}