/
PR
printhiv3d
/
Hive API Documentation
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5h ago · Updated 5h ago
latest
OpenAPI 3.0.3
2026-08-20
531
0
520.9 KB
6fe5e0368cb0
Action Feed
7
get
Get prioritized action feed for the organization
post
Mark an action feed item read or unread for the authenticated user
post
Dismiss an action feed item for the authenticated user
post
Acknowledge or dismiss action feed items
post
Assign or unassign an action feed item to a technician
get
Get the caller's read action feed keys
get
Get action feed history
Agent Auth
2
post
/agent/identity
post
/agent/identity/claim
AMS
2
get
Aggregated AMS slots across the organization's enabled printers
get
Per-printer AMS slots for mobile filament mapping
Analytics
5
get
Command dashboard overview KPIs
get
Daily utilization trend
get
Daily filament consumption by material
get
Jobs completed/failed per day
get
Printer efficiency breakdown by model
API Keys
8
post
Generate auth code
get
Exchange auth code for API key
post
Check auth code status
get
List API keys
post
Create API key
delete
Delete API key
patch
Update API key
get
Get API key logs
Assistant
1
post
Start a Hex realtime voice session
Assistant Feedback
5
get
List assistant answer feedback for an organization
post
Create or update feedback for one assistant answer
get
Assistant answer feedback trend metrics
patch
Update feedback rating/reason or maintainer review state
post
Draft a sanitized eval seed skeleton from negative feedback
Feature Flags
2
get
Get evaluated feature flags
get
Get evaluated feature flags for a host (API key auth)
Filament Consumption
8
get
List filament consumption records
get
Get consumption summary by material
get
Get consumption history for a material
post
Trigger filament consumption recording
get
Get consumption job status
get
List candidate jobs for consumption recording
get
Get filament consumption for a print job
patch
Manually assign filaments to a print job
Files
8
get
Get file metadata
get
Download file
delete
Delete file
get
Get single-file download URL
post
Restore Model File
get
Audit model files
delete
Clean up orphaned files
get
Get printers ranked by compatibility with a file
Hex
17
post
Create a server-bound Hex operation proposal
get
Read a canonical Hex operation proposal
post
Approve or cancel one canonical Hex operation proposal
post
Transcribe a short Hex voice command
post
Synthesize Hex speech audio for a spoken reply
get
Download synthesized Hex speech audio
get
List Hex conversations for the authenticated user and active organization
post
Create or update a Hex conversation snapshot
post
Record a Hex operation proposal audit event
post
Execute one approved, server-bound Hex operation proposal
get
Read the active user's org-scoped Hex assistant settings
put
Update the active user's org-scoped Hex assistant settings
get
Read the active organization's Hex capability map
post
Check whether the active organization may start a Hex turn
post
Open a Hex usage ledger row for one dispatch-gate decision
post
Finalize a Hex usage ledger row with a terminal status
get
Admin-only Hex usage history and spend attribution for an organization
Hive Link
11
post
Issue a short-lived paired-Host transfer credential and optionally bootstrap Pulse
post
Revoke the paired desktop's Pulse Host credential
get
List safe organization printer metadata with authoritative Host ownership
post
Resolve a local printer to its canonical cloud identity
post
Atomically claim an unassigned cloud printer for a paired Host
post
Assign or lease-safely move a cloud printer to a paired Hive Link Host
post
Issue a scoped Hive Link launch intent
post
Issue a file-only direct-transfer ticket
post
Resolve a signed desktop launch capability
post
Reserve a signed direct-transfer capability
post
Redeem a received direct-transfer capability
HiveSlice
10
get
List slice jobs
post
Create a slice job
get
Get slice job status
post
Cancel a slice job
post
Retry a failed slice job
post
Callback from slicing container
get
Get HiveSlice usage and quota
get
List slicer profiles
post
Upload a custom slicer profile
delete
Delete a custom slicer profile
Hosts
7
post
Rebalance printers across hosts
post
Register a host
patch
Update host last seen
get
Get printer assignments
post
Assign printer to host
delete
Remove printer from host
get
Get node credentials
Inventory
3
post
Add stock to inventory item
post
Remove stock from inventory item
post
Reconcile inventory against filament_consumption
Inventory Orders
7
get
List inventory orders
post
Create an inventory order
get
Get inventory order detail
delete
Cancel an inventory order
patch
Update an inventory order
post
Add items to an existing order
post
Receive items from an order
Inventory Transactions
1
post
Retry a failed inventory sync transaction
Lifecycle Emails
4
post
Run the trial activation lifecycle email sweep
get
Unsubscribe from lifecycle emails from an email link
post
Unsubscribe from lifecycle emails
get
Get lifecycle email status for an organization
Loop Runs
8
get
/v1/loop-runs
post
/v1/loop-runs
get
/v1/loop-runs/{id}
post
/v1/loop-runs/{id}/start
post
/v1/loop-runs/{id}/pause
post
/v1/loop-runs/{id}/resume
post
/v1/loop-runs/{id}/cancel
post
/v1/loop-runs/{id}/complete-iteration
Maintenance
9
get
Get maintenance plan and task states for a printer
get
Get due/overdue maintenance tasks across organization
get
Get maintenance dashboard summary
post
Complete a maintenance task
post
Snooze a maintenance task
post
Dismiss a maintenance task
put
Override maintenance task trigger intervals
post
Force re-evaluation of maintenance tasks
post
Seed maintenance tasks for a printer
Makes
16
post
Atomically create or update a Full Workshop Make
get
List makes
post
Create new make
get
Get make by ID
delete
Delete make
patch
Update make
get
List model files for make
post
Add model file to make
delete
Remove model file from make
patch
Link/unlink SKU
get
Get materials for a make model file
put
Set materials for a make model file
get
List makes for a model file
post
Create make for model file
delete
Validate that a model file has no default Make to clear
patch
Set default make for model file
Materials
10
post
Import and normalize retail filament
get
List filaments
post
Create filament
get
Get filament
delete
Delete filament
patch
Update filament
post
Upload material image
delete
Delete material image
patch
Record spool condition
get
Paginated Material Command Search
ML Models
2
get
/v1/ml-models/latest
get
/v1/ml-models/download/{version}
Mobile Briefing
1
get
Daily mobile briefing for the organization's Home screen
Model Files
10
get
Hydrate active and unresolved failed Model File operations
get
List active or deleted model files for one model
get
Count active and deleted model files for one model
get
Get one model file (active or deleted) for the workspace detail pane
patch
Update the sliced filament part labels for one active model file
post
Queue an active model file for authenticated reprocessing
get
Read a durable model-file reprocess receipt
get
Get the file-scoped operator overview for the workspace detail pane
get
List part mappings for a model file
put
Upsert part mappings for a model file
Models
24
post
Prepare a direct model file upload
post
Process uploaded model file storage objects
get
Get model by ID
delete
Delete model
patch
Update model
post
Restore model
get
Check if model exists
get
Get model file storage stats
get
Get Hive Drive model/file deltas
get
Get model changes since timestamp
get
List models
post
Create new model from external source
post
Generate AI tags for existing model
post
Upload model images
get
List model files
post
Upload model files
patch
Rename model file
put
Replace model file content
post
Retry Model File processing
get
Preview source deletion production impact
get
Read the latest Source Deletion Audit context
post
Confirm source deletion and disclosed production impact
post
Reap retained Model File bytes after protected work ends
post
Reconcile legacy unavailable-source work
OAuth
7
post
/v1/oauth/session-handoff
get
/.well-known/oauth-protected-resource
get
/.well-known/oauth-authorization-server
get
/v1/oauth/authorize
post
/v1/oauth/token
post
/v1/oauth/register
post
/v1/oauth/revoke
OAuth Clients
5
get
/v1/oauth-clients
post
/v1/oauth-clients
get
/v1/oauth-clients/{clientId}
delete
/v1/oauth-clients/{clientId}
patch
/v1/oauth-clients/{clientId}
Onboarding
2
get
List onboarding events for the organization
post
Record an onboarding event
Operator Dispatch
8
get
List operator dispatch profiles for the organization
get
Read the caller's dispatch profile
patch
Update the caller's dispatch profile
patch
Update another operator's dispatch profile
get
Read the operator-aware dispatch queue
post
Assign, unassign, or accept dispatch work
post
Preview a confirmation-gated assignment proposal
get
Read aggregate dispatch telemetry
Operator Sessions
1
post
Record a visible-app presence heartbeat for session summary delivery
Order Items
2
post
Map order item to model file
post
Skip order item
Orders
7
get
List orders
get
Get order by ID
patch
Update order
post
Reprocess order
post
Bulk map order items to model file
get
Get order events
get
Get order jobs
Organizations
6
get
List user organizations
patch
Update organization
get
List organization members
post
Invite or add an organization member
delete
Remove an organization member
patch
Update an organization member's role
Platform Credentials
4
get
Get platform credentials
post
Create new platform credentials
delete
Delete platform credentials
patch
Update platform credentials
Print Jobs
4
post
Duplicate a completed print job
patch
Update print job
get
List inventory sync transactions for a print job
post
Create inventory sync transactions for a completed print job
Printer Control
8
get
List recent Operator Release Batch receipts
post
Release an immutable batch of completed-job blockers
get
Restore one durable Operator Release Batch receipt
post
Retry unresolved items in an Operator Release Batch
get
List recent Triggered BOV receipts
post
Trigger Bed Occupancy Verification for completed jobs
post
Safely cancel a Triggered BOV batch
get
Restore one Triggered BOV receipt
Printer Tags
12
get
Get all tag templates
post
Create a new tag template
put
Update a tag template
delete
Delete a tag template
get
Get available tag keys
get
Get available tag values
get
Get tag statistics
post
Bulk update printer tags
get
Get printer tags
patch
Update printer tags
post
Apply tag template to printer
get
Get printers filtered by tags
Printers
15
get
/v1/printers/{id}/bed-occupancy-verification-config
patch
/v1/printers/{id}/bed-occupancy-verification-config
put
/v1/printers/{id}/stage-1-rollout-evidence
delete
/v1/printers/{id}/stage-1-rollout-evidence
put
/v1/printers/{id}/auto-bed-clear-enabled
get
/v1/printers/{id}/stage-1-hardware-profile
patch
/v1/printers/{id}/stage-1-hardware-profile
get
/v1/printers/{id}/ejection-config
put
/v1/printers/{id}/ejection-config
delete
/v1/printers/{id}/ejection-config
post
/v1/printers/{id}/test-ejection
get
/v1/printers/{id}/xcam-settings
patch
/v1/printers/{id}/xcam-settings
get
Read-only Smart Queue decision trace for a printer
get
/v1/printers/{id}/auto-bed-clear/preflight
Product SKUs
9
get
List product SKUs
post
Create new product SKU
get
Get product SKU by ID
delete
Delete product SKU
patch
Update product SKU
get
List model files for SKU
post
Link model file to SKU
delete
Remove model file mapping
post
Validate model file mapping
Production Capacity
6
get
Get capacity configuration
post
Configure production capacity
delete
Delete capacity configuration
patch
Update capacity configuration
get
List capacity alerts
get
Get capacity status
Production Runs
15
get
List Make Production Runs
get
Get Make Production Run detail
post
Cancel queued jobs linked to a Make Production Run
get
List Production Run Templates
post
Create a Production Run Template
patch
Update a Production Run Template
post
Archive a Production Run Template
get
List Production QR tokens for a template
post
Create a Production QR token for a template
patch
Update Production QR label metadata
post
Revoke a Production QR token
post
Rotate a Production QR token
post
Preview a Make Production Run from a template
post
Preview a Make Production Run from a QR token
post
Confirm a Make Production Run and enqueue print jobs
Public
1
get
Check for a Slicer Gateway desktop update
Purchase Requests
11
get
List purchase requests
post
Create a purchase request
get
Get purchase request counts by status
get
Get a purchase request by ID
delete
Delete a purchase request
patch
Edit a purchase request
post
Add items to a pending purchase request
delete
Remove an item from a purchase request
post
Approve a purchase request
post
Reject a purchase request
post
Cancel a purchase request
Recommendation Receipts
10
get
List assistant recommendation receipts for the organization
get
Recommendation follow-through analytics by action kind
post
Batch-create assistant recommendation receipts with dedupe
post
Promote selected farm-playbook recommendations into receipts
post
Accept (acknowledge) a recommendation receipt
post
Assign a recommendation receipt to a user
post
Mark a recommendation receipt done
post
Dismiss a recommendation receipt with a reason
post
Snooze a recommendation receipt until a later time
get
List a recommendation receipt's lifecycle audit events
RPI Image
4
post
Claim a host with a pre-provisioned token
post
Request Raspberry Pi image
get
Get RPI image request status
post
Update RPI image request status
Shippo
5
get
Initiate Shippo OAuth
get
OAuth callback
get
Check OAuth status
delete
Disconnect Shippo
post
Shippo webhook endpoint
Shopify
9
get
Shopify app launch handler
get
Get Shopify operations board
get
Get Shopify integration status
post
Start Shopify OAuth flow
get
Shopify OAuth callback
get
List Shopify inventory locations
post
Disconnect Shopify store
get
Get Shopify org settings
post
Update Shopify org settings
Shopify SKU Mapping
1
get
Get SKU mapping resolver context
Slicer
4
get
Slicer status & user info
get
List printers for slicer
post
Upload sliced file
post
Upload a sliced file for printing
Slicer Gateway
3
get
List Gateway routing printers
post
Route a captured slicer file
patch
Move a routed Gateway model file
Smart Queue
3
get
Smart Queue aging summary
get
Plan Smart Queue intervention bundles
post
Promote selected intervention bundle actions into receipts
Sub-Tasks
18
get
/v1/jobs/{jobId}/subtasks
post
/v1/jobs/{jobId}/subtasks
get
/v1/jobs/{jobId}/subtask-runs/{subtaskId}/review
patch
/v1/subtasks/{id}
post
/v1/subtasks/{id}/execute
post
/v1/subtasks/{id}/retry
post
/v1/subtasks/{id}/skip
get
/v1/printers/{id}/pending-subtasks
get
/v1/jobs/{jobId}/can-start
post
/v1/admin/subtask-test-runs
get
/v1/admin/subtask-runs
get
/v1/admin/subtask-runs/{subtaskId}
post
/v1/admin/subtask-runs/{subtaskId}/feedback
post
/v1/internal/subtasks/{id}/frames
post
/v1/internal/subtasks/{id}/events
post
/v1/internal/subtasks/{id}/claim-bed-clear-execution
post
/v1/internal/subtasks/{id}/consume-supervised-arm
post
/v1/internal/subtasks/{id}/result
Subscriptions
1
get
/v1/subscription/status
Support
1
get
Read the durable BOV and Bed-Clear Watch chronology
Tasks
7
get
List tasks
post
Create new task
get
Get task by ID
delete
Delete task
patch
Update task
get
List swimlanes
post
Create swimlane
Telemetry
3
post
Store telemetry metrics
get
Get telemetry metrics for a host
get
Get latest telemetry metrics
Training
8
get
Get training data statistics
get
List training frames
post
Review a training frame
get
Export training data
delete
Delete a training frame
get
Get prioritized review queue
get
Get training data opt-in status
post
Update training data opt-in status
Veeqo
4
post
Connect Veeqo integration
post
Disconnect Veeqo integration
get
Get Veeqo integration status
get
List Veeqo orders
get
/.well-known/openai-apps-challenge
get
/.well-known/integrations.json
get
/.well-known/mcp/server-card.json
get
/openapi.json
get
/v1/mcp/
post
/v1/mcp/
delete
/v1/mcp/
get
/v1/agent/identity/claim/inspect
post
/v1/agent/identity/claim/confirm
post
/v1/printer-events
post
/v1/printer-events/batch
get
/v1/printer-config
post
/v1/printer-config
get
/v1/printer-config/{id}
patch
/v1/printer-config/{id}
patch
/v1/printer-config/{id}/connection-status
post
/v1/printer-config/{id}/test-connection
post
/v1/printers/{id}/filaments/assign
patch
/v1/printers/{id}/maintenance
post
/v1/printers/{id}/operator-device-start
patch
/v1/printers/{id}/ready
post
/v1/printers/{id}/commands
put
/v1/printers/{id}/filaments/{position}
delete
/v1/printers/{id}/filaments/{position}
post
/v1/printers/{id}/ftp-health/failure
post
/v1/printers/{id}/ftp-health/success
post
/v1/printers/{id}/next-job
patch
/v1/printers/{id}/lock
get
/v1/printers/{id}/status
get
/v1/printers/{id}/frame
patch
/v1/printers/{id}/delete
get
/v1/printers/upload-speed
get
/v1/printers/orphaned-jobs
post
/v1/print-jobs/create
post
/v1/print-jobs/reorder
patch
/v1/print-jobs/{id}/assign
post
/v1/print-jobs/{id}/start
post
/v1/print-jobs
patch
/v1/print-jobs/{id}/status
get
/v1/print-jobs/{id}
delete
/v1/print-jobs/{id}
get
/v1/print-jobs/{id}/history
post
/v1/print-jobs/{id}/history
patch
/v1/print-jobs/{id}/retry
patch
/v1/print-jobs/{id}/file-verification
get
/v1/batch-jobs
post
/v1/batch-jobs
get
/v1/batch-jobs/{id}
patch
/v1/batch-jobs/{id}
get
/v1/batch-jobs/{id}/dashboard
post
/v1/batch-jobs/{id}/cancel
patch
/v1/batch-jobs/{id}/cancel
post
/v1/batch-jobs/empty
post
/v1/batch-jobs/{id}/jobs
post
/v1/batch-jobs/{id}/remove-jobs
post
/v1/batch-jobs/{id}/archive
post
/v1/batch-jobs/{id}/unarchive
get
/v1/listings
post
/v1/listings
get
/v1/listings/{id}
delete
/v1/listings/{id}
patch
/v1/listings/{id}
post
/v1/listings/{id}/sync
get
/v1/onboarding/status
post
/v1/onboarding/complete
post
/v1/loop-jobs
get
/v1/loop-jobs/{id}
post
/v1/discord/interactions
post
/v1/discord/webhook
get
/v1/discord/oauth-callback
get
/v1/discord/register-commands
get
/v1/discord/command-status
get
/v1/discord/debug-commands
get
/v1/notifications
post
/v1/notifications
post
/v1/notification-targets
post
/v1/notification-targets/device
get
/v1/notification-preferences
put
/v1/notification-preferences/org
put
/v1/notification-preferences/user
delete
/v1/notification-preferences/user/{eventType}
get
/v1/notification-preferences/printers/{printerId}
put
/v1/notification-preferences/printers/{printerId}
delete
/v1/notification-preferences/printers/{printerId}/{eventType}
get
/v1/recurring-error-config
put
/v1/recurring-error-config
get
/v1/printer-errors
delete
/v1/printer-errors
get
/v1/printer-errors/stats
get
/v1/farm-briefings/config
patch
/v1/farm-briefings/config
post
/v1/farm-briefings/preview
post
/v1/internal/farm-briefings/daily
get
/v1/at-risk-alerts/config
patch
/v1/at-risk-alerts/config
post
/v1/at-risk-alerts/preview
post
/v1/internal/at-risk-alerts/run
get
/v1/notification-control-center
put
/v1/notification-control-center/briefing
put
/v1/notification-control-center/at-risk-alerts
get
/v1/notifications/unread-count
post
/v1/notifications/read-all
post
/v1/notifications/dismiss-all
post
/v1/notifications/{id}/read
post
/v1/notifications/{id}/dismiss
get
/v1/organizations/{organizationId}/settings
put
/v1/organizations/{organizationId}/settings
get
/v1/org/{id}/subscription
post
/v1/org/{id}/subscription/upgrade
post
/v1/org/{id}/subscription/seats
get
/v1/org/{id}/subscription/seats/preview
get
/v1/org/{id}/billing
post
/v1/org/{id}/printers
post
/v1/webhook/stripe
get
/v1/updates/latest
get
/v1/updates/check
get
/v1/updates/download/{version}
get
/v1/updates/stats
get
/v1/install/{script}
get
/v1/install
post
/webhook/shopify
get
/v1/organizations/{organizationId}/pause-light-settings
put
/v1/organizations/{organizationId}/pause-light-settings
get
/v1/pause-light-settings/host
post
/v1/organizations/{organizationId}/pause-light-settings/preview
get
/v1/organizations/{organizationId}/schedules/bed-clear-watch
put
/v1/organizations/{organizationId}/schedules/bed-clear-watch
get
/v1/organizations/{organizationId}/operator-annotations
post
/v1/organizations/{organizationId}/operator-annotations
delete
/v1/organizations/{organizationId}/operator-annotations/{id}
patch
/v1/organizations/{organizationId}/operator-annotations/{id}
post
/v1/organizations/{organizationId}/operator-annotations/{id}/resolve
get
/v1/printer-tasks
post
/v1/printer-tasks
get
/v1/printer-tasks/{id}
delete
/v1/printer-tasks/{id}
patch
/v1/printer-tasks/{id}
get
/v1/search
get
/v1/health
get
/.well-known/openai-apps-challenge
Response
Default Response