Plugon adds a layer of knowledge to your assets and spatial environments, new or existing: photos, hi-res images, 3D models and video. A plug is a spatial data point: a label, fact, measurement or comment anchored to a precise location by people or AI. The API connects that layer to your systems: post assets from any app, workflow or environment, add plugs from your own vision model or from Plugon's AI, which learns from your channels, and pull the labelled data back out. You don't need to build a user interface: your teams review, search and correct the results in Plugon.
For CTOs and CIOsWhat your teams capture in the field, on the factory floor or in the lab becomes one searchable record, with every plug's author and source. Use your own models or ours, keep channels private, and pay for what you use. For developersOne endpoint and one JSON request of up to 20 actions. Keys you manage on this page, and examples in curl, JavaScript and Python. For researchers and data teamsRead every plug's box in original image pixels to train and evaluate models. Send your model's boxes back so people can check and correct them. Get an API key Quick start Start Explore, discover and interact Quick start API keys Requests and answers Plug boxes Actions read_post search create_post scan_post scan_status upload_init / complete More Errors and limits Billing Security Your data Embed a channel Build with usEverything you send through the API shows up in your Plugon channels, on phones and desktops, for the people you choose. Make posts and channels private, invite editors and admins from your team, and invite partners to the channels they work on. Your teams browse it, open a post, and tap a plug to read what is known about that spot. It is a ready-to-use interactive spatial platform, so there are no screens to build. Business accounts can brand it with your logo, banner and theme color, and embed posts and channels in your own website or app. How access works
Posts as tilesYour posts in a channel or search result, as they look on a small phone. A single postEach round marker is a plug, anchored to the spot it describes. A plug, openedTap a plug to see its box and its note, then add to it or correct it.https://plugon.us/go/api with the header apikey.create_post. People see, search and correct them in Plugon.
AI plugs that know your workEvery new post gets up to 5 AI plugs, learned from the channels you name.
Read back for trainingread_post and search give every plug's box, ready for your own model.
A key acts as your account. A full access key can read what you can read and post as you; a read only key can call read_post, search and scan_status and nothing else. Every account can have up to 25 keys. Delete a key and it stops working at once.
| Header | |
|---|---|
apikey | Your key. |
Content-Type | application/json |
The body is a JSON array of 1 to 20 actions. Every action has "v": "3.0" and an action name. Your key tells Plugon which account is calling, so there is no account name to send. The answer is an array in the same order as your actions, so the first answer belongs to the first action.
The answer is an array with one result per action, in the same order. A result has "ok": true and its data, or "ok": false and an error with a code and a message. One failed action doesn't stop the others.
A problem with the whole request, such as bad JSON, a wrong key or too many requests, gets an HTTP 4xx status and a single error object instead of the array.
Every plug has a box: left, top, width and height, in pixels of the original image. The post's image.width × image.height is that original's size; for a hi-res post (image.hires: true) it is the full-resolution original. You get back the same numbers you send.
The origin is the top-left corner, x grows to the right and y grows down. left and top are the box's top-left corner, not its centre. If your model gives centre points (YOLO) or [ymin, xmin, ymax, xmax] (TensorFlow), convert before you send. Need fractions? Divide by image.width and image.height.
AI plugs have ai: {source, model, confidence}.
A plug can have a color ("#rrggbb") and either one object from the library below or a pointer line. You send them in create_post plugs, and read_post gives them back in the same form. An object is {"type": "motion", "name": "arrow-down"} and is drawn inside the plug's box in the plug's color. A line is {"x1", "y1", "x2", "y2"} in pixels of the original image, the same coordinates as the box; both ends must be inside the plug's box.
| type | name |
|---|---|
symbol | ⇦arrow-left ⇧arrow-up ⇨arrow-right ⇩arrow-down ↔arrow-left-right ➚arrow-up-right ➠arrow-right-bold ✔check ➘arrow-down-right ➥arrow-curve-down-right ✖cross ↺rotate-left ↻rotate-right ❤heart ☚point-left ☛point-right ↶undo ↷redo ↑arrow-up-thin ↓arrow-down-thin ⚠warning ☣biohazard ¤currency ☎phone |
icon | shopping_cartshopping-cart paymentpayment redeemredeem monetization_onmonetization-on |
motion | Animated arrows and paths: directional circular circular-ccw wave expanding zigzag arrow-up arrow-down arrow-left arrow-right arrow-updown arrow-leftright |
A plug can carry a drawing: up to 20 strokes, each {"points": [[x, y], …], "color": "#rrggbb", "closed": true}. Points use the plug box's own coordinate system: [0, 0] is the box's top-left corner, x grows to the right up to width and y grows down to height, in pixels of the original image. A closed stroke (the default) joins its last point to its first, which suits outlines; "closed": false leaves it open, for lines and measurements. Strokes are drawn 2px wide, in the stroke's color or else the plug's. Drawings people make with the pen in the app come back from read_post the same way.
Outlines from a model, such as a defect, a lesion in a medical image or a part in an inspection photo: subtract the box's left from every x and its top from every y, then send the points with the finding's text. If your model gives a mask rather than an outline, trace the mask's outline first (for example with OpenCV's findContours) and send that. Every point must be inside the box; a plug with a drawing can't also have an object or a line. Limits: 20 strokes and 2,000 points per stroke, 10,000 points per plug, 50,000 in one create_post.
Returns one post and every plug on it: its text, its box in original-image pixels, its color, object, line or drawing, and where it came from (ai). Give id, the post's 32-character id, or url, its link on plugon.us. Access follows your account: public and unlisted posts, and private posts you own, moderate or that are shared with you.
Finds posts by words, a channel (#tag@name) or an account (@name), under the same privacy rules as plugon.us. Returns up to 100 post summaries.
| Field | |
|---|---|
query | Words, #tag@name or @name, up to 300 characters. Add after:2026-01-01 or before:2026-06-30 to limit by date. |
visibility | public (the default, what visitors see), unlisted, private or all. The last three find posts only in accounts you own or moderate; elsewhere they find nothing more than public. Word searches are always public. |
max_results | 1 to 100, default 20. |
include_plugs | true returns every result with its plugs, as read_post does, in one answer. max_results is then at most 20. |
Without include_plugs each result is a post without its plugs. To read more than 20 in full, send up to 20 read_post actions in one request.
Turns an image into a live, searchable post. When the answer arrives, the post and its plugs are already on plugon.us, on the web and in the phone apps, for the people you choose: there is no viewer to build. Send your own model's boxes in plugs, or leave them out and Plugon's AI adds up to 5 labelled plugs in the background (paid accounts, when the post has a description or post_to).
| Field | |
|---|---|
image | The image as base64 (a data: prefix is fine): jpg, png or webp, up to about 20MB. |
image_url | Or an https link to the image, up to 25MB. Plugon downloads it. |
name | Post name. |
description | What the picture is about. For AI plugs, #tag names one of your channels to learn from, #tag@name or @name another account's public posts, and links become the source. |
post_to | Up to 3 channels, "#parts #lathe" or an array. Their hashtags go on the first plug, which puts the post in those channels. |
visibility | public, unlisted or private. If left out, your account's default is used. |
plugs | Your own plugs, up to 50: {text, left, top, width, height} in pixels of the image you send (see Plug boxes). model, confidence, color, and an object or line (see Colors, objects and pointer lines) or a drawing (see Drawings and outlines) are optional. With plugs, no AI scan runs. |
ai | false turns off the AI scan for this post. |
Without plugs, every post gets up to 5 AI plugs, each "Label: fact", with or without a description; send ai: false to turn that off. The scan runs in the background: the answer has scan.state: "pending", then scan_status tells you when it's done (usually 10 to 20 seconds).
AI plugs on a post you already have, for posts in your own account. Paid accounts only. The AI reads what the post's plugs already say and the links in them, adds up to 5 new plugs on other things, and can move and name the existing plugs. It runs while you wait, 10 to 30 seconds, and answers with the post and its plugs.
| Field | |
|---|---|
id or url | The post. |
references | Up to 5 of your channels to learn from, such as ["#lathe"]. |
hint | What to look for, up to 200 characters. |
links | Up to 2 https pages to read for the facts. Links in the post's plugs are read too, up to 2 pages in all, yours first. The first new plug cites them. |
use_plugs | false scans the image as if the post had no plugs. Default true: their text is context, and no new box is put on top of one. |
existing_plugs | keep (default) leaves them as they are. refine lets the AI move each plain plug onto the thing its text is about and put a short name in front of its text; plugs with a drawing, object or line stay put. |
post_to | Channels for the first new plug, as in create_post. |
The answer's scan has found (new plugs), refined (plugs moved or named) and links (pages read). In the app, owners find the same scan in a post's menu as Auto Plugs, with an Undo.
Where a post's AI scan is. scan.state is pending, ready, failed or none; once it's done, the answer has the post with its plugs. Polling every 3 seconds is enough.
For big images, up to 250MB (jpg or png, paid accounts). The file goes straight to storage, and the post gets deep zoom, its full size and AI plugs.
upload_init with name (such as "site.jpg") and size in bytes answers upload.id and upload.url.upload.url.upload_complete with that id, plus name, description and post_to. The post is made at once from a preview, and the full size follows in a few minutes. A PNG over 40 megapixels has no preview: the answer says upload.state: "queued" without a post, and the post appears when the full size is ready, usually within a minute; poll scan_status with the same id until it has the post.| Code | Meaning |
|---|---|
unauthorized | Missing, wrong or deleted key (HTTP 401). |
rate_limited | Too many requests or scans. Wait retry_after seconds (HTTP 429 for the whole request). |
invalid_json, invalid_request, too_many_actions, invalid_action | The body is not a JSON array of 1 to 20 actions, or one of its actions is not a JSON object. |
bad_version, unknown_action | Set "v": "3.0" and use an action named on this page. |
not_found, invalid_id | No such post, or not one this account can read or change. |
invalid_query | search has no query, or it is over 300 characters. |
not_uploaded | upload_complete came before the file was PUT to upload.url. |
forbidden | The action needs a paid account, or the key is read only. |
https_required | The request came over plain http (HTTP 403). Use https://plugon.us/go/api. |
invalid_image, bad_image, bad_url, fetch_failed, too_large | The image is missing, not a jpg, png or webp, too big, or its link could not be downloaded. Links must be https on a public address. |
invalid_plugs | A plug has no text or no valid box; the message says which one. |
invalid_drawing | A drawing point is outside its box, a stroke has too many points, or a color is not #rrggbb; the message names the plug, the stroke and the point. |
scan_failed, server_error | Something went wrong on our side; try again. |
create_post.The API counts the same interactions as plugon.us: a new post or an AI scan costs the same through the API as on the site, and AI scans are charged by what the model used. Reading and searching are free within the rate limits. The Dashboard shows your interactions.
https_required.apikey header and never in a link. Keys work only on the API: they cannot sign in to plugon.us, change account settings or manage keys. Read only keys cannot post or scan.Files and text you send are kept in your account like any other post, with the visibility you choose, and you can delete them at any time.
For AI plugs, the image, its description and examples from the channels you name are sent to Google's Gemini models on Vertex AI. Under Google Cloud's terms, that data is not used to train Google's models. See the privacy policy.
Show a channel or a whole account on your own site, no key needed. Change emcolor1 to your color.
If your company analyses images, video or 3D scans, Plugon can be the front end where people see, search and correct the results. Tell us what you build and we'll help you connect.

|
|
_754131
DIS_bdfa35
USERCOMMENTTEXT
|
_3f185e
|
|
edit_note
|
| |
|
| < |
Spotlight
Trending
Latest
My Posts
Discover
|
> |
SCREEN_NAME _0931be |
_bdfa35
_88967e Likes
_daf461 Views
_516839 Hovers
|
| |
![]() |
|
| clear clear |
| Share | |
| | LOGIN | |
| Channels | |
| | Save To | |
| | Add Object | |
| |
| Message Dialog |
|
|
| | |
|
|
| | New | |
| | NEW | |
|
Collections
remove_circle
delete_forever
|
||
|
person_add
check_circle
|
||
|
|
|
|
|
remove_circle
|
||
|
|
||
|
|
||
| |
Allow Messaging Anyone can send you a Note |
|
| | Allow Plug Addition |
|
|
|
||
|
|
||
|
|
||
| | Enable AR Mode |
|
| auto_awesome | Edit Image | |
| auto_fix_high | Auto Plugs | |
| | Improve Detection | |
| | Detect In Scene | |
| insights | Post Analytics | |
| | Delete | |
| |
Show in Search
Search on Plugon, Recent for free accounts
|
|
| |
Show in Recent
Public posts, paid accounts too
|
|
| |
Sensitive Content
Shows Sensitive Mask
|
|
|
Auto Text |
check_circle
|
|