v4

latestOpenAPI 3.0.32026-08-024840393.1 KB
Filament Consumption
Debug

Trigger filament consumption recording

Triggers filament consumption recording for an existing print job or all eligible jobs. Use trigger_all: true to queue all jobs without consumption records. Jobs can be re-triggered to update existing consumption data (e.g., after correcting material mappings). Worker uses upsert logic to prevent duplicates. Useful for testing and backfilling consumption data. For users in multiple organizations, specify organizationId to select which organization's jobs to trigger.

post/v1/filament-consumption/trigger

Request body

organizationIdstring uuid

Organization ID to trigger jobs for. User must be a member of the organization. Defaults to user's first organization if not specified.

print_job_idnumber

The print job ID to record consumption for (required if trigger_all is false)

status_override'COMPLETED' | 'FAILED' | 'CANCELLED'

Override the job status (uses actual job status if not provided)

trigger_allboolean

If true, queue all eligible jobs without consumption records

backfill_unknownboolean

If true, re-queue jobs that have consumption records with null material_id (Unknown Material). Uses upsert to update existing records.

limitnumber

Maximum number of jobs to queue when trigger_all is true

Response

Default Response

queue_job_idstring
print_job_idnumber
queuednumber
failednumber