The Mira External API provides read-only programmatic access to your Mira data sites, cylinders, and scans.
\nAll API requests require a Bearer Token obtained from the Developer Settings page in your Mira dashboard.
\nLog in to your Mira dashboard
\nNavigate to Settings → Developer
\nClick Create New API Key
\nGive your key a descriptive name (e.g. \"ERP Integration\")
\nCopy the token immediately it will only be shown once
\nUse it as a Bearer token in the Authorization header
Include the token in every request:
\nAuthorization: Bearer 1|aBcDeFgHiJkLmNoPqRsTuVwXyZ123456789...\n\nTokens expire after 1 year. You can regenerate or revoke tokens at any time from the Developer Settings page.
\nhttps://mira.javolin.com/api/external\n\nAPI calls are tracked and can be reviewed on the Developer Settings page.
\nYou will only see data belonging to your company. Admin users can see all data.
\nThis is a read-only API. Only GET requests are supported.
Sites: Physical locations where cylinders are managed
\nCylinders: Anilox rollers with specifications and measurements
\nScans: Individual scan measurements taken on cylinders
\nReturns the currently authenticated user's profile. Use this to verify your API token is valid and working.
\nReturns the full user object including name, email, and preferences.
\n","urlObject":{"path":["user"],"host":["https://mira.javolin.com/api/external"],"query":[],"variable":[]}},"response":[{"id":"dd6e694d-aad6-4311-a62d-b66c68d8705d","name":"Valid Token","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"78|fWZ3ITZxmhRsa7XRsVTlDgmspT0xt7S5BlHSOakC63301551"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mira.javolin.com/api/external/user","description":"## Verify Token\n\nReturns the currently authenticated user's profile. Use this to verify your API token is valid and working.\n\n### Response\n\nReturns the full user object including name, email, and preferences."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"created_at\": \"2025-06-15T08:00:00.000000Z\"\n}"},{"id":"8c2e47aa-5715-46e3-b8e5-4b5405be02de","name":"Invalid / Expired Token","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"78|fWZ3ITZxmhRsa7XRsVTlDgmspT0xt7S5BlHSOakC63301551"}},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mira.javolin.com/api/external/user","description":"## Verify Token\n\nReturns the currently authenticated user's profile. Use this to verify your API token is valid and working.\n\n### Response\n\nReturns the full user object including name, email, and preferences."},"status":"Unauthenticated","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"}],"_postman_id":"0ea4771e-a023-435b-b927-1f013daddc81"}],"id":"d6e132c9-20f0-4ddf-804c-4ecf9b534b24","description":"Verify your API token is working correctly.
\napi_token collection variable or pass it as Authorization: Bearer <token>Returns a paginated list of sites accessible to the authenticated user.
\nNon-admin users only see sites belonging to their company.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_API_TOKEN_HERE"}]},"isInherited":true,"source":{"_postman_id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","name":"Mira External API","type":"collection"}},"urlObject":{"path":["sites"],"host":["https://mira.javolin.com/api/external"],"query":[{"description":{"content":"Page number for pagination
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Search sites by name
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by company ID (use 'all' to skip filter)
\n","type":"text/plain"},"key":"company_id","value":""},{"disabled":true,"description":{"content":"Sort by: name, city, company, cylinders, updated_at
\n","type":"text/plain"},"key":"sort_by","value":"name"},{"disabled":true,"description":{"content":"Sort direction: asc or desc
\n","type":"text/plain"},"key":"sort_dir","value":"asc"}],"variable":[]}},"response":[{"id":"80778e41-111d-4680-8e3a-86d03f6bdd1c","name":"Site List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mira.javolin.com/api/external/sites?page=1","host":["https://mira.javolin.com/api/external"],"path":["sites"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"search","value":"","description":"Search sites by name","disabled":true},{"key":"company_id","value":"","description":"Filter by company ID (use 'all' to skip filter)","disabled":true},{"key":"sort_by","value":"name","description":"Sort by: name, city, company, cylinders, updated_at","disabled":true},{"key":"sort_dir","value":"asc","description":"Sort direction: asc or desc","disabled":true}]},"description":"## List All Sites\n\nReturns a paginated list of sites accessible to the authenticated user.\n\n### Query Parameters\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `page` | integer | Page number (default: 1) |\n| `search` | string | Search by site name |\n| `company_id` | string | Filter by company ID. Use `all` to skip filter |\n| `sort_by` | string | Sort field: `name`, `city`, `company`, `cylinders`, `updated_at` |\n| `sort_dir` | string | Sort direction: `asc` or `desc` |\n\n### Access Control\n\nNon-admin users only see sites belonging to their company."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"uid\": \"abc-123-def\",\n \"name\": \"Chicago Plant\",\n \"company_id\": \"5\",\n \"coordinate\": \"41.8781,-87.6298\",\n \"country\": \"US\",\n \"state\": \"IL\",\n \"city\": \"Chicago\",\n \"license_id\": null,\n \"meta\": null,\n \"last_call\": \"2025-12-01T10:30:00.000000Z\",\n \"created_at\": \"2025-06-15T08:00:00.000000Z\",\n \"updated_at\": \"2025-12-01T10:30:00.000000Z\",\n \"cylinders_count\": 24,\n \"company\": {\n \"id\": 5,\n \"name\": \"Acme Printing\"\n }\n }\n ],\n \"links\": {\n \"first\": \"https://mira.javolin.com/api/external/sites?page=1\",\n \"last\": \"https://mira.javolin.com/api/external/sites?page=3\",\n \"prev\": null,\n \"next\": \"https://mira.javolin.com/api/external/sites?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 3,\n \"per_page\": 15,\n \"total\": 42\n }\n}"}],"_postman_id":"2fe8dc25-f143-4f42-b06c-17484facf928"},{"name":"Get Single Site","id":"738c9438-cd7a-4412-93bb-263c530bcbe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mira.javolin.com/api/external/sites/:id","description":"Returns details for a specific site including its company and cylinder count.
\nSite ID
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"738c9438-cd7a-4412-93bb-263c530bcbe8"}],"id":"7f89e7e9-0b9c-4e44-b3a5-c4bbf041c9b4","description":"Sites represent physical locations where cylinders are managed and scanned. Each site belongs to a company and can have many cylinders.
\nReturns a paginated list of cylinders with computed fields.
\nEach cylinder includes:
\nvolume_percentage — ROUND((current_volume / spec_volume) * 100) scans_count — Total number of scanslast_scan_date — Date of the most recent scanNon-admin users only see cylinders belonging to their company.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_API_TOKEN_HERE"}]},"isInherited":true,"source":{"_postman_id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","name":"Mira External API","type":"collection"}},"urlObject":{"path":["cylinders"],"host":["https://mira.javolin.com/api/external"],"query":[{"description":{"content":"Page number for pagination
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Filter by site ID
\n","type":"text/plain"},"key":"site_id","value":""},{"disabled":true,"description":{"content":"Search by press_id, serial_number, or cylinder_id
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by manufacturer name (partial match)
\n","type":"text/plain"},"key":"manufacturer","value":""},{"disabled":true,"description":{"content":"Filter by press ID (partial match)
\n","type":"text/plain"},"key":"press_id","value":""},{"disabled":true,"description":{"content":"Filter by cylinder ID (partial match)
\n","type":"text/plain"},"key":"cylinder_id","value":""},{"disabled":true,"description":{"content":"Only show cylinders below 80% volume threshold
\n","type":"text/plain"},"key":"require_action","value":"true"}],"variable":[]}},"response":[{"id":"47127bc5-366c-43a3-a78f-60b5c82c8c02","name":"Cylinder List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mira.javolin.com/api/external/cylinders?page=1","host":["https://mira.javolin.com/api/external"],"path":["cylinders"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"site_id","value":"","description":"Filter by site ID","disabled":true},{"key":"search","value":"","description":"Search by press_id, serial_number, or cylinder_id","disabled":true},{"key":"manufacturer","value":"","description":"Filter by manufacturer name (partial match)","disabled":true},{"key":"press_id","value":"","description":"Filter by press ID (partial match)","disabled":true},{"key":"cylinder_id","value":"","description":"Filter by cylinder ID (partial match)","disabled":true},{"key":"require_action","value":"true","description":"Only show cylinders below 80% volume threshold","disabled":true}]},"description":"## List All Cylinders\n\nReturns a paginated list of cylinders with computed fields.\n\n### Query Parameters\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `page` | integer | Page number (default: 1) |\n| `site_id` | string | Filter by site ID |\n| `search` | string | Search by press_id, serial_number, or cylinder_id |\n| `manufacturer` | string | Filter by manufacturer (partial match) |\n| `press_id` | string | Filter by press ID (partial match) |\n| `cylinder_id` | string | Filter by cylinder ID (partial match) |\n| `require_action` | boolean | Only show low-volume cylinders (below 80% of spec) |\n\n### Computed Fields\n\nEach cylinder includes:\n- `volume_percentage` — `ROUND((current_volume / spec_volume) * 100)` \n- `scans_count` — Total number of scans\n- `last_scan_date` — Date of the most recent scan\n\n### Access Control\n\nNon-admin users only see cylinders belonging to their company."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"uid\": \"cyl-abc-123\",\n \"site_id\": \"1\",\n \"cylinder_id\": \"ANX-001\",\n \"manufacturer\": \"Praxair\",\n \"serial_number\": \"SN-2024-0451\",\n \"cylinder_type\": \"anilox\",\n \"diameter\": 150.0,\n \"length\": 1200.0,\n \"face_width\": 1050.0,\n \"dead_band_width\": 25.0,\n \"num_bands\": 3,\n \"tir_left\": 0.0,\n \"tir_center\": 0.0,\n \"tir_right\": 0.0,\n \"engraver_id\": \"\",\n \"engraver_operator\": \"\",\n \"customer_id\": \"\",\n \"customer_name\": \"Acme Corp\",\n \"customer_po\": \"\",\n \"work_order_number\": \"\",\n \"spec_line_screen\": 800.0,\n \"spec_screen_angle\": 60.0,\n \"spec_volume\": 4.5,\n \"current_volume\": 3.8,\n \"press_id\": \"PRESS-A\",\n \"designation\": null,\n \"manufacture_date\": \"2024-01-15\",\n \"comment\": null,\n \"meta\": null,\n \"created_at\": \"2025-06-15T08:00:00.000000Z\",\n \"updated_at\": \"2025-12-01T10:30:00.000000Z\",\n \"volume_percentage\": 84,\n \"scans_count\": 12,\n \"last_scan_date\": \"2025-11-28T14:22:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https://mira.javolin.com/api/external/cylinders?page=1\",\n \"last\": \"https://mira.javolin.com/api/external/cylinders?page=5\",\n \"prev\": null,\n \"next\": \"https://mira.javolin.com/api/external/cylinders?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 5,\n \"per_page\": 15,\n \"total\": 72\n }\n}"}],"_postman_id":"14a7685c-6742-47d0-8c4b-9da3408d7f7e"},{"name":"Get Single Cylinder","id":"095dcd16-99fd-4b00-af06-6130453057e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mira.javolin.com/api/external/cylinders/:id","description":"Returns details for a specific cylinder including its computed fields.
\nCylinder ID (database ID)
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"095dcd16-99fd-4b00-af06-6130453057e7"}],"id":"eb2ffd5b-82be-4e0b-a850-25612570167d","description":"Cylinders represent anilox rollers. Each cylinder belongs to a site and has specifications (volume, line screen, screen angle) along with physical measurements. Cylinders can have many scans over time to track wear.
\nReturns a paginated list of scan measurements. Scans are ordered by group number and recency.
\nEach scan includes these computed attributes:
\nvolume_bcm — cell_volume + cap_volume + correction_factordepth_volume_ratio — cell_depth / volume_bcm (unit-aware based on user preferences)depth_opening_ratio — cell_depth / cell_openingmedia_urls — Signed S3 URLs for 3D picture and PCD file (valid for ~10 minutes)instrument — Related instrument detailsNon-admin users only see scans from sites belonging to their company.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_API_TOKEN_HERE"}]},"isInherited":true,"source":{"_postman_id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","name":"Mira External API","type":"collection"}},"urlObject":{"path":["scans"],"host":["https://mira.javolin.com/api/external"],"query":[{"description":{"content":"Page number for pagination
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Filter by cylinder ID (database ID)
\n","type":"text/plain"},"key":"cylinder_id","value":""}],"variable":[]}},"response":[{"id":"3b69cd16-441e-44b8-9153-2ffe74d858c1","name":"Scan List","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://mira.javolin.com/api/external/scans?page=1","host":["https://mira.javolin.com/api/external"],"path":["scans"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"cylinder_id","value":"","description":"Filter by cylinder ID (database ID)","disabled":true}]},"description":"## List All Scans\n\nReturns a paginated list of scan measurements. Scans are ordered by group number and recency.\n\n### Query Parameters\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `page` | integer | Page number (default: 1) |\n| `cylinder_id` | string | Filter scans by cylinder ID |\n\n### Computed Fields\n\nEach scan includes these computed attributes:\n- `volume_bcm` — `cell_volume + cap_volume + correction_factor`\n- `depth_volume_ratio` — `cell_depth / volume_bcm` (unit-aware based on user preferences)\n- `depth_opening_ratio` — `cell_depth / cell_opening`\n- `media_urls` — Signed S3 URLs for 3D picture and PCD file (valid for ~10 minutes)\n- `instrument` — Related instrument details\n\n### Access Control\n\nNon-admin users only see scans from sites belonging to their company."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"uid\": \"scan-abc-123\",\n \"site_id\": \"1\",\n \"cylinder_id\": \"1\",\n \"group_number\": 1,\n \"scan_number\": 1,\n \"band_number\": 1,\n \"scan_date_time\": \"2025-11-28T14:22:00.000000Z\",\n \"cell_volume\": 3.2,\n \"cap_volume\": 0.5,\n \"correction_factor\": 0.1,\n \"line_screen\": 800.0,\n \"screen_angle\": 60.0,\n \"cells_analyzed\": 150,\n \"cell_depth\": 28.5,\n \"cell_opening\": 22.3,\n \"cell_length\": 18.1,\n \"saddle_depth\": 5.2,\n \"wall_width\": 4.8,\n \"channel_width\": 12.5,\n \"land_area_percent\": 35.0,\n \"stylus_angle\": 120.0,\n \"status\": 0,\n \"image_file_name\": \"scan_001.png\",\n \"point_cloud_file_name\": \"scan_001.pcd\",\n \"scan_comment\": null,\n \"meta\": {\n \"resource_path\": \"sites/1/cylinders/ANX-001/\"\n },\n \"volume_bcm\": 3.8,\n \"depth_volume_ratio\": 7.5,\n \"depth_opening_ratio\": 1.278,\n \"media_urls\": {\n \"picture_3d\": \"https://s3.amazonaws.com/...signed-url...\",\n \"pcd_file\": \"https://s3.amazonaws.com/...signed-url...\"\n },\n \"instrument\": null,\n \"site\": {\n \"id\": 1,\n \"name\": \"Chicago Plant\"\n },\n \"created_at\": \"2025-11-28T14:22:00.000000Z\",\n \"updated_at\": \"2025-11-28T14:22:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https://mira.javolin.com/api/external/scans?page=1\",\n \"last\": \"https://mira.javolin.com/api/external/scans?page=10\",\n \"prev\": null,\n \"next\": \"https://mira.javolin.com/api/external/scans?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 10,\n \"per_page\": 15,\n \"total\": 148\n }\n}"}],"_postman_id":"f4cf4071-b643-4e39-aa6a-dccc0517ef13"},{"name":"Get Single Scan","id":"572f00a8-1364-4b30-a1a1-9153093fadad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://mira.javolin.com/api/external/scans/:id","description":"Returns details for a specific scan including computed fields and signed media URLs.
\nThe media_urls field contains time-limited signed S3 URLs:
picture_3d — 3D scan imagepcd_file — Point cloud data fileThese URLs expire after approximately 10 minutes. Request the scan again to get fresh URLs.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_API_TOKEN_HERE"}]},"isInherited":true,"source":{"_postman_id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","id":"4ad20bb5-7c9e-4555-8e4b-8807758efc53","name":"Mira External API","type":"collection"}},"urlObject":{"path":["scans",":id"],"host":["https://mira.javolin.com/api/external"],"query":[],"variable":[{"id":"db0c8b52-d307-47d2-8c1d-4bda5e28f47b","description":{"content":"Scan ID
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"572f00a8-1364-4b30-a1a1-9153093fadad"}],"id":"52a60f89-fcc4-48aa-9b5c-1547d9fa116b","description":"Scans represent individual measurements taken on a cylinder band. Each scan captures cell geometry, volume data, and optionally includes 3D images and point cloud files.
\n