Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the CupixWorks API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcupixworks.com%2Fcupixworks" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcupixworks.com%2Fcupixworks" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with CupixWorks API.
Create, update, publish, and unpublish annotation layers via /annotation-layers operations
Read and write per-annotation-layer metadata via /annotation-layers/{id}/metadata
Manage categories used to classify annotations via /categories CRUD
Track construction progress entries via the /progress endpoints
Manage workflow definitions and statuses for review steps
GET STARTED
Drive review records that move work between team members via /reviews
Patterns agents use CupixWorks API for, with concrete tasks.
★ Automated Construction Progress Logging
A construction project agent can record weekly progress entries against milestones in CupixWorks based on data from a project management tool. By calling the /progress endpoints with the relevant site, milestone, and timestamp, the agent keeps the digital twin in sync with reported progress without site engineers manually duplicating updates.
Call POST /progress with the milestone ID and percent complete pulled from the project plan.
Annotation Layer Review Bot
A site supervisor's review bot can list pending annotation layers, route them to the right reviewer using the workflow and status endpoints, and publish the layers once approval is logged. The publish and unpublish endpoints make it safe to gate releases of new annotations to the wider team only after sign-off.
List annotation layers in pending status, then call PUT /annotation-layers/{id}/publish for each one approved by the reviewer.
Category and Workflow Configuration
When a new project starts, a setup agent can stamp the standard categories, statuses, and workflow definitions into the CupixWorks project so the team starts from a consistent template. Calls to /categories, /statuses, and /workflows replace manual click-through configuration with a repeatable script.
Loop the standard category list and call POST /categories for each entry, then POST /workflows with the standard review states.
AI Agent Integration via Jentic
An AI assistant for a construction or surveying team can use Jentic to discover CupixWorks operations rather than implementing 31 endpoints directly. The agent searches Jentic for an intent like 'create an annotation layer on a site capture', loads the schema, and runs the call against the bearer token Jentic holds for the project.
Use Jentic search for 'create an annotation layer on a CupixWorks site' and execute the matching POST /annotation-layers operation.
31 endpoints — jentic publishes the only available openapi specification for cupixworks api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
/annotation-layers
List annotation layers
/annotation-layers
Create an annotation layer
/annotation-layers/{id}
Update an annotation layer
/annotation-layers/{id}/publish
Publish an annotation layer
/annotation-layers/{id}/unpublish
Unpublish an annotation layer
/annotation-layers/{id}/metadata
Get annotation layer metadata
/categories
List categories
/annotation-layers
List annotation layers
/annotation-layers
Create an annotation layer
/annotation-layers/{id}
Update an annotation layer
/annotation-layers/{id}/publish
Publish an annotation layer
/annotation-layers/{id}/unpublish
Unpublish an annotation layer
/annotation-layers/{id}/metadata
Get annotation layer metadata
/categories
List categories
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the CupixWorks API by hand means placing the bearer token in the Authorization header, targeting the api.cupixworks.com host, and handling retries across annotation and workflow routes yourself. Through Jentic you install once, import the CupixWorks API from the API Directory, store the token once, and your agent calls it.
Permission scoping
CupixWorks puts the annotation layer id in the URL path (/annotation-layers/{id}), so a rule can pin your agent to one annotation layer: it can read and update that layer and nothing else. You choose the operations it may call, so ones like publishing or unpublishing a layer are not included unless you add them.
Credential isolation
Your CupixWorks bearer token is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create an annotation layer on a CupixWorks site', and Jentic returns the matching CupixWorks operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using CupixWorks API through Jentic.
Why is there no official OpenAPI spec for CupixWorks API?
CupixWorks does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CupixWorks API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the CupixWorks API use?
CupixWorks uses an HTTP bearer token in the Authorization header. Through Jentic the token is stored in your encrypted Jentic One instance and injected at request time so the agent never handles the raw secret in its prompt or outputs.
Can I publish an annotation layer with the CupixWorks API?
Yes. After creating a layer with POST /annotation-layers, run PUT /annotation-layers/{id}/publish to publish it to the wider team. Use the matching unpublish endpoint to revert if a reviewer flags an issue.
What are the rate limits for the CupixWorks API?
The Jentic-maintained spec does not publish explicit rate limits because CupixWorks does not document them publicly. Use modest batch sizes when bulk-creating annotation layers or progress entries and back off on 429 responses.
How do I create an annotation layer with the CupixWorks API through Jentic?
Run pip install jentic, search Jentic for 'create an annotation layer on a CupixWorks site', load the schema for POST /annotation-layers, and execute it with the site and metadata. Jentic injects the bearer token from your Jentic One instance so the integration code stays clean.
How do I track construction progress with the CupixWorks API?
Use the /progress endpoints to record progress entries against milestones. Pair them with the workflow and status endpoints to move milestones through the project's review states automatically.
Can I limit what my agent is allowed to do with the CupixWorks API?
Yes. Because you run Jentic One yourself, your own rules decide which CupixWorks operations and credentials the agent may use. Since the API puts the annotation layer id in the path (/annotation-layers/{id}), you can pin the agent to a single layer so it only reads and updates that one and nothing else. You also choose the operations it may call, so publishing or unpublishing a layer stays off limits unless you explicitly add it.
Know of an official OpenAPI document? Contribute it →
For Agents
Manage annotation layers, categories, progress, statuses, workflows, and reviews on CupixWorks construction digital twins. Useful for AI agents that automate site documentation and review handoffs.
Use for: Create a new annotation layer on a CupixWorks site capture, Publish an annotation layer once review is complete, I want to record progress against a construction milestone, Update the metadata on an existing annotation layer
Not supported: Does not handle 3D capture upload, viewer rendering, or user account management - use for CupixWorks annotation layers, categories, progress, statuses, workflows, and reviews only.
Jentic publishes the only available OpenAPI specification for CupixWorks API, keeping it validated and agent-ready. The CupixWorks API exposes the construction and built-environment digital-twin platform, which lets teams manage 3D site captures and overlay annotations, categories, statuses, progress milestones, workflows, and review steps. The API covers full CRUD on annotation layers, including publish and unpublish actions and per-layer metadata, and parallel CRUD for categories, progress entries, statuses, workflows, and reviews. Authentication uses a bearer token, suitable for server-side automation that ingests project events and synchronises CupixWorks records.