UpKeep Maintenance Management API
67
AI ReadinessAI-Aware (B)67/100
Official vendor OpenAPI document · agent-readyIdentity AuthAuthenticationnone10 EndpointsREST
For Agents
Programmatically login and obtain session token, logout and invalidate session token. Covers 10 operations.
Use for: I need to login and obtain session token, I want to logout and invalidate session token, Search for work orders, Find all a work order
Not supported: Does not handle payments, communications, or crm - use for identity and authentication only.
UpKeep API for managing work orders, assets, locations, and maintenance requests. Supports session token-based authentication for CMMS operations. The API exposes 10 endpoints.
Install Jentic One Beta
Connect the UpKeep Maintenance Management API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the UpKeep Maintenance Management 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.
1
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%2Fupkeep.com%2Fupkeep" | sh2
Step 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%2Fupkeep.com%2Fupkeep" | 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.
Capabilities
What an agent can do with UpKeep Maintenance Management API.
Login and obtain session token
Logout and invalidate session token
List work orders
Create a work order
Change work order status
Get a particular asset
Use Cases
Patterns agents use UpKeep Maintenance Management API for, with concrete tasks.
★ Identity and Authentication Operations
Use the UpKeep Maintenance Management API to perform identity auth operations programmatically. The API provides 10 endpoints covering core functionality including login and obtain session token, logout and invalidate session token, list work orders.
Call POST /login to login and obtain session token
Automated Assets Management
Automate assets operations by combining multiple UpKeep Maintenance Management API endpoints. Agents can logout and invalidate session token and then list work orders in a single workflow.
Call POST /logout to logout and invalidate session token, then verify the result
AI Agent Integration via Jentic
AI agents discover and call UpKeep Maintenance Management API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.
Search Jentic for 'login and obtain session token', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
10 endpoints — upkeep api for managing work orders, assets, locations, and maintenance requests.
METHOD
PATH
DESCRIPTION
POST
/login
Login and obtain session token
POST
/logout
Logout and invalidate session token
POST
/workorders
List work orders
POST
/workorder
Create a work order
POST
/workorder-status
Change work order status
POST
/assets
List assets
POST
/assets/{id}
Get a particular asset
POST
/locations
List locations
POST
/login
Login and obtain session token
POST
/logout
Logout and invalidate session token
POST
/workorders
List work orders
POST
/workorder
Create a work order
POST
/workorder-status
Change work order status
POST
/assets
List assets
POST
/assets/{id}
Get a particular asset
POST
/locations
List locations
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
U
UpKeep Maintenance Management API
- AI-Aware (B)67/100
100
Foundational Compliance58
Developer Experience & Jentic Compatibility41
AI-Readiness & Agent Experience94
Agent Usability100
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
58
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: C+Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
30%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
41
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D-Signals: 4
32%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
80%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the UpKeep Maintenance Management API by hand means running its login flow to obtain a session token, threading that token through every work-order and asset call, and refreshing it yourself. Through Jentic you install once, import UpKeep from the API Directory, store the credential once, and your agent calls it.
Permission scoping
UpKeep puts the asset id in the URL path (/assets/{id}), so a rule can pin your agent to reading and updating a specific asset while still allowing it the work-order operations you list. You choose the operations it may call, so nothing beyond creating or updating work orders and reading assets runs unless you add it.
Credential isolation
Your UpKeep credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'log in and obtain a session token' or 'create a work order', and Jentic returns the matching UpKeep operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using UpKeep Maintenance Management API through Jentic.
What authentication does the UpKeep Maintenance Management API use?
The UpKeep Maintenance Management API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I login and obtain session token with the UpKeep Maintenance Management API?
Yes. Use the POST /login endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the UpKeep Maintenance Management API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I login and obtain session token through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'login and obtain session token'. Jentic returns the matching UpKeep Maintenance Management API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the UpKeep Maintenance Management API have?
The UpKeep Maintenance Management API exposes 10 endpoints covering assets, authentication, locations operations.
Can I limit what my agent is allowed to do with the UpKeep Maintenance Management API?
Yes. Jentic One runs self-hosted, so your own rules decide which UpKeep operations and credentials the agent may use. You can allow it to list and create work orders (POST /workorders, POST /workorder) and change their status (POST /workorder-status) while withholding everything else, so no other call runs unless you add it. Because UpKeep puts the asset id in the URL path (POST /assets/{id}), a rule can also pin the agent to reading a specific asset rather than the full /assets list.
GET STARTED