Send an approved order and a production ticket, get back what doesn’t match. Included in Pro and Enterprise.
Getting started
The JobGuard API lets your own software (for example your shop management system) compare an approved order with a production ticket and save the result to a JobGuard workspace. It’s included in the Pro and Enterprise plans.
Open Saved workspaces, choose your workspace and go to API access.
Create a key and copy it. It’s shown only once.
Send it with every request in the Authorization header.
Authorization: Bearer jg_your_key_here
Keep keys secret, like a password: use them only from your server, never in a web page or app that customers can open. Revoke a key at any time in API access.
Run a check
POST https://jobguardai.com/api/v1/check compares two texts and returns what differs. Nothing is saved.
type is mismatch (both documents have the detail, with different values) or missing (one document doesn’t have it).
Save a review
POST https://jobguardai.com/api/v1/reviews saves the documents as a review in the workspace, so your team can check it in JobGuard. Workflow automation rules (assignment, extra reviewers) apply as usual.
Returns 201 with id, version, findings, assignedTo and usage. reference is optional (one line, up to 120 characters).
List and read reviews
GET https://jobguardai.com/api/v1/reviews?limit=50 lists saved reviews (newest first, up to 200) with their status: awaiting, reviewed or needs_followup.
GET https://jobguardai.com/api/v1/reviews/{id} returns one review with both texts, its findings and the team’s review entries.
Limits and counting
Rate limit: 60 requests a minute per key. Over that, you get 429 with a Retry-After header.
Order checks: each check and each saved review counts as one order check toward your plan, the same as in the app. Going over your plan never blocks the API; the usage.warning field tells you when you’re near or over.
Size: each text can be up to 200,000 characters. Saved reviews follow the workspace’s retention setting.
Keys: up to 10 active keys per workspace.
Errors
Errors return JSON like {"error":"…"} with a status code:
400 the request body is missing something or is too long
401 the key is missing, wrong or revoked
403 the workspace’s plan doesn’t include API access
404 the review or route doesn’t exist
429 too many requests; wait and retry
Need help?
Email jobguardai2@gmail.com. JobGuard points out differences; it never approves or rejects a job, so keep a person in charge of the final decision.