Create a new Filament for the current user.
source says how the starting amount was measured: 1 Weight, 2 Length or 3 Volume. The other two are derived from it where the density and diameter allow. Weights are in milligrams.
Request
- Base URL: https://api.3dprintlog.com
- URL: https://api.3dprintlog.com/api/Filaments
- Auth: one of:
- OAuth 2 (authorization code, authorization URL https://3dprintlog.auth0.com/authorize, token URL https://3dprintlog.auth0.com/oauth/token)
- API key in header X-Api-Key
- API key in query parameter api_key
Request body
Common name for the roll of filament.
The material Type, ie PLA, PETG, ABS.
The Density of the Material
Which field is the user-entered "source"
Sent as an integer: 1 = Weight, 2 = Length, 3 = Volume.
The initial volume of the material in millileters
The initial length of the material in meters
The initial nominal weight of the filament in milligrams.
The weight of the spool in milligrams.
The user's recommended temperature
The user's recommended Bed temperature
The location (either URL, or physical location where the filament was purchased)
The Currency Marker (ie, USD)
Any notes about the purchase price
Where is this filament stored?
The initial layer cure time in seconds
The layer cure time in seconds (after the initial layers)
Melting temperature of the material
What inert gas should be used?
The percentage of new powder when mixing with old powder. 1.0 means always use new powder.
Sent as an integer: 1 = Solid, 2 = Multi, 3 = Gradient, 4 = Rainbow.
Sent as an integer: 1 = Standard, 2 = Silk, 3 = Matte.
RFID or NFC tag UIDs on this spool, in any case and with any separators (04:A2:3f:11). Stored as uppercase hex without separators (04A23F11), and unique across the user's spools: a UID already on another spool is a 409.
The SpoolmanDB catalog entry the spool was created from. Settable on create only: it is validated there (an unknown or removed entry is a 400) and a PUT never changes it.
Response
The filament detail DTO that was created.
The user's own number for this spool (1, 2, 3…), which Spoolman clients use as its id. Read-only: assigned on create, never reused, and ignored on PUT.
Common name for the roll of filament.
The material Type, ie PLA, PETG, ABS.
The Density of the Material
Which field is the user-entered "source"
Sent as an integer: 1 = Weight, 2 = Length, 3 = Volume.
The initial volume of the material in millileters
The initial length of the material in meters
The initial nominal weight of the filament in milligrams.
The weight of the spool in milligrams.
Server-computed remaining filament weight in milligrams (InitialNominalWeightMg minus print usage plus weight adjustments). Null when nominal weight is not set. Read-only: ignored on write.
Server-computed remaining length in meters, converted from FilamentRemaining so the three readouts always describe the same spool. Null when the nominal weight is not tracked, and null for materials with no diameter - resin and powder have no length. Get-only: a client-supplied value cannot reach the server.
Server-computed remaining volume in milliliters, converted from FilamentRemaining. Deliberately NOT accumulated from the per-usage VolumeMl columns: a usage row written without normalization carries milligrams and no volume, and summing the volume column then silently under-counts the spool. Get-only: a client-supplied value cannot reach the server.
Distinct prints that used this filament. Read-only: ignored on write.
Total milligrams consumed by prints, actual where recorded and estimated otherwise - the same rule FilamentRemaining subtracts. Read-only: ignored on write.
The user's recommended temperature
The user's recommended bed temperature
The location (either URL, or physical location where the filament was purchased)
The Currency Marker (ie, USD)
Any notes about the purchase price
Where is this filament stored?
The initial layer cure time in seconds
The layer cure time in seconds (after the initial layers)
Melting temperature of the material
What inert gas should be used?
The percentage of new powder when mixing with old powder. 1.0 means always use new powder.
Sent as an integer: 1 = Solid, 2 = Multi, 3 = Gradient, 4 = Rainbow.
Sent as an integer: 1 = Standard, 2 = Silk, 3 = Matte.
RFID or NFC tag UIDs on this spool, as uppercase hex without separators (04A23F11), in order. Always a list in responses. On PUT, any case and separators are accepted and the list replaces the spool's tags; leave it out (or null) to keep them, which is what clients that predate tags do. A UID already on another of the user's spools is a 409 naming that spool.
The catalog entry the spool was created from. Response-only: a PUT never changes it.
Changes
No recorded changes to this operation across all 1 revision of this API.