Materials

View as Markdown

Materials your SKUs' designs are printed in.

The material object

Attributes

  • idstring

    Opaque public identifier for this material (mat_ prefix + 33 base62 chars). Use this value verbatim when referencing the material in other endpoints.

  • namestring

    Display name of the material.

  • typestring

    Filament family (e.g. PLA, PETG, ABS).

  • colorobjectOptional

    Optional colour hint, free-text or hex.

The material object
{
  ,
  ,
  ,
  
}

List materials visible to your farm

GET/v1/print-farm/materials

Credentials
An API key with the SKU or FULL permission.
For
Print farms
Operation id
listPrintFarmMaterials

Returns a paginated list of materials reachable from your farm, sorted by name. A material is visible iff it is referenced as a default-type entry in skus.design_list[].materials[] of a SKU that appears in one of your allocated orders, or in a SKU whose stock is held at one of your farms. Materials outside that chain are not returned. Requires an API key with the SKU (or FULL) permission scope.

Query parameters

  • pageinteger

    1-based page index.

    Range at least 1. Defaults to 1.
  • page_sizeinteger

    Page size (max 100).

    Range 1 to 100. Defaults to 20.
  • idstring

    Filter by material id. Accepts a comma-separated list of UUIDs.

  • namestring

    Filter by material name (case-insensitive partial match).

  • typestring

    Filter by material type (case-insensitive partial match).

Returns200 OK

Paginated list of materials visible to the authenticated farm.

Responses

  • 200

    Paginated list of materials visible to the authenticated farm.

  • 400

    page or page_size is outside the allowed range.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have the required permission scope.

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

  • 500

    An unexpected error occurred on our side.

Errors use the print farm error body.

GET/v1/print-farm/materials
curl "https://public-api.dapi.digital/v1/print-farm/materials" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "materials": [
    {
      "id": "mat_jR6tN9pXq4sL8mB3dK7vH2cF5wYzA1ePsK",
      "name": "Polymaker Polyterra Cotton White",
      "type": "PLA",
      "color": "#FFFFFF"
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 42
}

Get one material visible to your farm

GET/v1/print-farm/materials/{id}

Credentials
An API key with the SKU or FULL permission.
For
Print farms
Operation id
getPrintFarmMaterial

Returns the material matching the given id, scoped to materials reachable from your farm via the SKU graph (orders ∪ stock_levels). Requires an API key with the SKU (or FULL) permission scope.

Path parameters

  • idstringRequired

    The public material identifier (mat_…) returned by the list endpoint.

Returns200 OK

The requested material. Returns the material object.

Responses

  • 200

    The requested material.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have the required permission scope.

  • 404

    No material with this id is visible to your farm (it may exist in the catalog but isn't referenced via any SKU reachable through your orders or stock_levels).

  • 429

    Rate limit exceeded - wait until the window resets before retrying.

  • 500

    An unexpected error occurred on our side.

Errors use the print farm error body.

GET/v1/print-farm/materials/{id}
curl "https://public-api.dapi.digital/v1/print-farm/materials/mat_jR6tN9pXq4sL8mB3dK7vH2cF5wYzA1ePsK" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "id": "mat_jR6tN9pXq4sL8mB3dK7vH2cF5wYzA1ePsK",
  "name": "Polymaker Polyterra Cotton White",
  "type": "PLA",
  "color": "#FFFFFF"
}