Skip to main content
POST
/
materials
/
parts
Create a parts record
curl --request POST \
  --url https://api.autoprintfarm.com/public/v1/materials/parts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "color": "<string>",
  "brand": "<string>",
  "compatible_models": [
    "<string>"
  ],
  "remaining_units": 0,
  "low_threshold": 1,
  "location": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "type": "<string>",
    "name": "<string>",
    "color": "<string>",
    "brand": "<string>",
    "remaining_units": 123,
    "low_threshold": 123,
    "status": "<string>",
    "location": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "compatible_models": "<unknown>"
  }
}

Authorizations

​
Authorization
string
header
required

API keys are minted in the AutoPrintFarm web app under Settings → API Keys. Send as Authorization: Bearer apf_live_.... Keys are shown exactly once at creation and can be revoked at any time.

Body

application/json
​
type
string
required
Required string length: 1 - 100
​
name
string | null
Maximum string length: 200
​
color
string | null
Maximum string length: 50
​
brand
string | null
Maximum string length: 100
​
compatible_models
string[] | null
​
remaining_units
integer
default:0
Required range: x >= 0
​
low_threshold
integer | null
Required range: x >= 0
​
location
string | null
Maximum string length: 200

Response

Created

​
success
enum<boolean>
required
Available options:
true
​
data
object
required