The design object
Attributes
- idstring
Opaque public identifier for this design (
dsg_prefix + 33 base62 chars). Use this value verbatim when referencing the design in other endpoints. - namestring
Display name of the design.
- descriptionobjectOptional
Free-text description of the design.
- color_numberobjectOptional
Number of distinct colours the design uses.
- extra_partsobjectOptional
Free-text description of any non-printed parts needed.
- extra_parts_configobjectOptional
Structured configuration of the extra parts (e.g. quantities, images). Returned verbatim from storage.
- required_filamentboolean
Whether the design requires a specific filament (see
materials_configfor the allowed set). - ams_requiredboolean
Whether the design requires an Automatic Material System (AMS).
- assemblyboolean
Whether the design requires post-print assembly.
- farm_instructionsobjectOptional
Print-farm-facing instructions for producing the design.
- materials_configobjectOptional
Material configuration for the design. Shape:
{ mode, allowed_materials, saved_combinations? }. Returned verbatim from storage. - hours_multiplierobjectOptional
Multiplier applied to baseline print time when estimating production hours, as a numeric string.
- grams_multiplierobjectOptional
Multiplier applied to baseline filament usage when estimating grams, as a numeric string.
- post_processing_multiplierobjectOptional
Multiplier applied to baseline post-processing time, as a numeric string.
- design_filesarray of PrintFarmDesignFileDto
All model files for this design (STL/3MF/etc.), each with a short-lived presigned download URL. Sorted by upload date (newest first).
- extra_filesarray of PrintFarmDesignFileDto
Supporting files attached to this design (PDFs, manuals, spec sheets). Each entry includes a presigned download URL. Empty when no extras are uploaded.
{
"id": "dsg_kP4xT8aBnLf2sH9eY3jZ5dM7cR1vQbWtJ",
"name": "Dragon Figurine",
"description": "Articulated dragon, 12cm tall.",
"color_number": 1,
"extra_parts": "Two M3 screws and one spring.",
"extra_parts_config": {},
"required_filament": false,
"ams_required": false,
"assembly": false,
"farm_instructions": "Print at 0.2mm layer height. Brim recommended.",
"materials_config": {
"mode": "single",
"allowed_materials": [
{
"name": "Polymaker Polyterra Cotton White",
"type": "custom"
}
]
},
"hours_multiplier": "1.00",
"grams_multiplier": "1.00",
"post_processing_multiplier": "1.00",
"design_files": [
{
"id": "dfl_pL3xB9sK6mT2nH7yC1jZ4dR8vQ5wA9uXkF",
"file_name": "dragon.3mf",
"file_type": "model/3mf",
"size": 524288,
"download_url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"url_expires_at": "2025-05-20T15:30:00.000Z"
}
],
"extra_files": [
{
"id": "dfl_pL3xB9sK6mT2nH7yC1jZ4dR8vQ5wA9uXkF",
"file_name": "dragon.3mf",
"file_type": "model/3mf",
"size": 524288,
"download_url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"url_expires_at": "2025-05-20T15:30:00.000Z"
}
]
}List approved designs visible to your farm
GET/
- Credentials
- An API key with the
SKUorFULLpermission. - For
- Print farms
- Operation id
listPrintFarmDesigns
Returns a paginated list of approved designs reachable from your farm. A design is visible iff it is referenced by a SKU that appears in one of your allocated orders, or in a SKU whose stock is held at one of your farms. Each entry includes a short-lived presigned URL for downloading the design file. Requires an API key with the SKU (or FULL) permission scope.
Query parameters
- pageinteger
1-based page index.
- page_sizeinteger
Page size (max 100).
- idarray of string
Filter by design id. Accepts a comma-separated list of UUIDs.
- namestring
Filter by design name (case-insensitive partial match).
- ams_requiredboolean
Filter to designs that require (true) or do not require (false) an AMS.
- assemblyboolean
Filter to designs that require (true) or do not require (false) assembly.
- required_filamentboolean
Filter to designs that require (true) or do not require (false) a specific filament.
Returns200 OK
Paginated list of approved designs visible to the authenticated farm.
Responses
- 200
Paginated list of approved designs visible to the authenticated farm.
- 400
pageorpage_sizeis 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.
curl "https://public-api.dapi.digital/v1/print-farm/designs" \
-H "x-api-key: $DAPI_API_KEY"{
"designs": [
{
"id": "dsg_kP4xT8aBnLf2sH9eY3jZ5dM7cR1vQbWtJ",
"name": "Dragon Figurine",
"description": "Articulated dragon, 12cm tall.",
"color_number": 1,
"extra_parts": "Two M3 screws and one spring.",
"extra_parts_config": {},
"required_filament": false,
"ams_required": false,
"assembly": false,
"farm_instructions": "Print at 0.2mm layer height. Brim recommended.",
"materials_config": {
"mode": "single",
"allowed_materials": [
{
"name": "Polymaker Polyterra Cotton White",
"type": "custom"
}
]
},
"hours_multiplier": "1.00",
"grams_multiplier": "1.00",
"post_processing_multiplier": "1.00",
"design_files": [
{
"id": "dfl_pL3xB9sK6mT2nH7yC1jZ4dR8vQ5wA9uXkF",
"file_name": "dragon.3mf",
"file_type": "model/3mf",
"size": 524288,
"download_url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"url_expires_at": "2025-05-20T15:30:00.000Z"
}
],
"extra_files": [
{
"id": "dfl_pL3xB9sK6mT2nH7yC1jZ4dR8vQ5wA9uXkF",
"file_name": "dragon.3mf",
"file_type": "model/3mf",
"size": 524288,
"download_url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"url_expires_at": "2025-05-20T15:30:00.000Z"
}
]
}
],
"page": 1,
"page_size": 20,
"total": 42
}Get one approved design visible to your farm
GET/
- Credentials
- An API key with the
SKUorFULLpermission. - For
- Print farms
- Operation id
getPrintFarmDesign
Returns the approved design matching the given id, scoped to designs reachable from your farm via the SKU graph (orders ∪ stock_levels), with a short-lived presigned URL for downloading the design file. Requires an API key with the SKU (or FULL) permission scope.
Path parameters
- idstringRequired
The public design identifier (
dsg_…) returned by the list endpoint.
Returns200 OK
The requested design. Returns the design object.
Responses
- 200
The requested design.
- 401
API key is missing or invalid.
- 403
The API key does not have the required permission scope.
- 404
No approved design with this
idis visible to your farm (it may exist in the catalog but isn't reachable via any of 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.
curl "https://public-api.dapi.digital/v1/print-farm/designs/dsg_kP4xT8aBnLf2sH9eY3jZ5dM7cR1vQbWtJ" \
-H "x-api-key: $DAPI_API_KEY"{
"id": "dsg_kP4xT8aBnLf2sH9eY3jZ5dM7cR1vQbWtJ",
"name": "Dragon Figurine",
"description": "Articulated dragon, 12cm tall.",
"color_number": 1,
"extra_parts": "Two M3 screws and one spring.",
"extra_parts_config": {},
"required_filament": false,
"ams_required": false,
"assembly": false,
"farm_instructions": "Print at 0.2mm layer height. Brim recommended.",
"materials_config": {
"mode": "single",
"allowed_materials": [
{
"name": "Polymaker Polyterra Cotton White",
"type": "custom"
}
]
},
"hours_multiplier": "1.00",
"grams_multiplier": "1.00",
"post_processing_multiplier": "1.00",
"design_files": [
{
"id": "dfl_pL3xB9sK6mT2nH7yC1jZ4dR8vQ5wA9uXkF",
"file_name": "dragon.3mf",
"file_type": "model/3mf",
"size": 524288,
"download_url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"url_expires_at": "2025-05-20T15:30:00.000Z"
}
],
"extra_files": [
{
"id": "dfl_pL3xB9sK6mT2nH7yC1jZ4dR8vQ5wA9uXkF",
"file_name": "dragon.3mf",
"file_type": "model/3mf",
"size": 524288,
"download_url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"url_expires_at": "2025-05-20T15:30:00.000Z"
}
]
}