API Endpoints

Complete reference for all AutoPrintFarm API endpoints.

Printers

List Printers

GET /v1/printers

Query Parameters:

• status - Filter by status (idle, printing, offline)
• group - Filter by group ID
• tag - Filter by tag
• page - Page number
• per_page - Results per page (max 100)

Example:

curl "https://api.autoprintfarm.com/v1/printers?status=printing" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "data": [
    {
      "id": "prt_abc123",
      "name": "Prusa-A-01",
      "status": "printing",
      "model": "Prusa i3 MK3S+",
      "firmware": "OctoPrint 1.8.0",
      "temperatures": {
        "hotend": 215,
        "bed": 60
      },
      "current_job": "job_xyz789",
      "progress": 45,
      "group": "production",
      "tags": ["enclosed", "multi-material"],
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-10-06T14:25:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 45,
    "total_pages": 3
  }
}

Get Printer

GET /v1/printers/:id

Create Printer

POST /v1/printers

Body:

{
  "name": "Prusa-B-05",
  "connection_url": "http://192.168.1.105",
  "api_key": "OctoPrint-API-Key",
  "model": "Prusa i3 MK3S+",
  "group": "production",
  "tags": ["enclosed"]
}

Update Printer

PATCH /v1/printers/:id

Delete Printer

DELETE /v1/printers/:id

Printer Actions

POST /v1/printers/:id/actions

Actions:

• pause - Pause current job
• resume - Resume paused job
• cancel - Cancel current job
• home - Home all axes
• cooldown - Cool down heaters

Example:

curl -X POST "https://api.autoprintfarm.com/v1/printers/prt_abc123/actions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"action": "pause"}'

---

Jobs

List Jobs

GET /v1/jobs

Query Parameters:

• status - queued, printing, completed, failed, cancelled
• printer_id - Filter by printer
• priority - low, normal, high, urgent
• from - Start date (ISO 8601)
• to - End date (ISO 8601)

Get Job

GET /v1/jobs/:id

Response:

{
  "id": "job_xyz789",
  "name": "part-001.gcode",
  "status": "printing",
  "priority": "normal",
  "printer_id": "prt_abc123",
  "progress": 45,
  "file_url": "https://cdn.autoprintfarm.com/files/xyz789.gcode",
  "estimated_duration": 7200,
  "elapsed_time": 3240,
  "material": {
    "type": "PLA",
    "color": "Black",
    "estimated_usage": 45.2
  },
  "created_at": "2025-10-06T12:00:00Z",
  "started_at": "2025-10-06T12:15:00Z",
  "completed_at": null
}

Create Job

POST /v1/jobs

Body:

{
  "file_url": "https://your-cdn.com/model.gcode",
  "name": "custom-part-v2",
  "priority": "high",
  "printer_id": "prt_abc123",  // Optional - auto-assign if omitted
  "material": "PLA",
  "copies": 1,
  "tags": ["production", "order-456"]
}

With File Upload:

curl -X POST "https://api.autoprintfarm.com/v1/jobs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@model.gcode" \
  -F "name=custom-part" \
  -F "priority=high"

Update Job

PATCH /v1/jobs/:id

Cancel Job

DELETE /v1/jobs/:id

---

Materials

List Materials

GET /v1/materials

Get Material

GET /v1/materials/:id

Response:

{
  "id": "mat_pla001",
  "type": "PLA",
  "brand": "Hatchbox",
  "color": "Black",
  "spool_weight": 1000,
  "remaining_weight": 650,
  "cost_per_kg": 20.00,
  "printer_id": "prt_abc123",
  "reorder_threshold": 100,
  "status": "active",
  "created_at": "2025-09-01T10:00:00Z"
}

Add Material

POST /v1/materials

Update Material

PATCH /v1/materials/:id

---

Analytics

Fleet Overview

GET /v1/analytics/fleet

Query Parameters:

• from - Start date
• to - End date
• group - Filter by group

Response:

{
  "period": {
    "from": "2025-10-01T00:00:00Z",
    "to": "2025-10-06T23:59:59Z"
  },
  "metrics": {
    "total_printers": 45,
    "active_printers": 38,
    "utilization_rate": 84.4,
    "jobs_completed": 1247,
    "success_rate": 96.8,
    "total_print_time": 89234,
    "material_consumed": 34567,
    "estimated_cost": 691.34
  }
}

Printer Statistics

GET /v1/analytics/printers/:id

Job Statistics

GET /v1/analytics/jobs

Material Usage

GET /v1/analytics/materials

---

Webhooks

List Webhooks

GET /v1/webhooks

Create Webhook

POST /v1/webhooks

Body:

{
  "url": "https://your-app.com/webhook",
  "events": [
    "job.created",
    "job.started",
    "job.completed",
    "job.failed",
    "printer.offline",
    "printer.online",
    "material.low"
  ],
  "secret": "webhook_secret_key",
  "enabled": true
}

Available Events:

• job.* - All job events
• job.created, job.started, job.completed, job.failed
• printer.* - All printer events
• printer.online, printer.offline, printer.error
• material.* - All material events
• material.low, material.empty

Update Webhook

PATCH /v1/webhooks/:id

Delete Webhook

DELETE /v1/webhooks/:id

Test Webhook

POST /v1/webhooks/:id/test

---

Organizations

Get Organization

GET /v1/organization

Update Organization

PATCH /v1/organization

---

Users

List Users

GET /v1/users

Get User

GET /v1/users/:id

Invite User

POST /v1/users/invite

---

Error Codes

Code	Description
invalid_request	Request format invalid
invalid_api_key	API key invalid or expired
insufficient_permissions	Missing required scope
resource_not_found	Resource doesn’t exist
printer_busy	Printer already printing
printer_offline	Printer not connected
file_invalid	G-code file invalid
quota_exceeded	Plan limit reached
rate_limit_exceeded	Too many requests
internal_error	Server error

---

Rate Limits

See API Overview - Rate Limiting for details.

---

Pagination

All list endpoints support pagination:

GET /v1/jobs?page=2&per_page=50

Maximum per_page: 100

---

Sorting

Sort results with sort parameter:

GET /v1/jobs?sort=-created_at  # Descending
GET /v1/jobs?sort=priority     # Ascending

---

Field Selection

Request specific fields only:

GET /v1/printers?fields=id,name,status

Reduces response size and improves performance.

---

SDK Examples

JavaScript

import { AutoPrintFarm } from '@autoprintfarm/sdk';

const client = new AutoPrintFarm({ apiKey: 'YOUR_KEY' });

// List printers
const printers = await client.printers.list({ status: 'printing' });

// Create job
const job = await client.jobs.create({
  file_url: 'https://example.com/model.gcode',
  priority: 'high'
});

// Get analytics
const analytics = await client.analytics.fleet({
  from: '2025-10-01',
  to: '2025-10-06'
});

Python

from autoprintfarm import Client

client = Client(api_key='YOUR_KEY')

# List printers
printers = client.printers.list(status='printing')

# Create job
job = client.jobs.create(
    file_url='https://example.com/model.gcode',
    priority='high'
)

# Get analytics
analytics = client.analytics.fleet(
    from_date='2025-10-01',
    to_date='2025-10-06'
)

---

Next Steps

• Try the API Explorer
• Set up webhooks
• View example integrations