Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Shireburn Indigo People 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%2Fshireburn.com%2Fshireburn" | 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%2Fshireburn.com%2Fshireburn" | 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 Shireburn Indigo People API.
Add a new employee
List employees
Submit leave request
Query and filter Shireburn Indigo People API records by parameters
Monitor Shireburn Indigo People API operational status and events
GET STARTED
Patterns agents use Shireburn Indigo People API for, with concrete tasks.
★ HR and Recruiting Operations
Use the Shireburn Indigo People API to perform hr recruiting operations programmatically. The API provides 4 endpoints covering core functionality including add a new employee, list employees, submit leave request.
Call POST /employees to add a new employee
Automated employees Management
Automate employees operations by combining multiple Shireburn Indigo People API endpoints. Agents can list employees and then submit leave request in a single workflow.
Call GET /employees to list employees, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Shireburn Indigo People 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 apiKey tokens manually.
Search Jentic for 'add a new employee', load the operation schema, and execute with Jentic-managed credentials
4 endpoints — api for hr and employee management.
METHOD
PATH
DESCRIPTION
/employees
Add a new employee
/employees
List employees
/leave-requests
Submit leave request
/leave-requests
List leave requests
/employees
Add a new employee
/employees
List employees
/leave-requests
Submit leave request
/leave-requests
List leave requests
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Shireburn Indigo People API by hand means placing your key in the Authorization header, pointing at the api.shireburn.com host, and threading it through employee and leave-request calls yourself. Through Jentic you install once, import the Shireburn Indigo People API from the API Directory, store the key once, and your agent calls it.
Permission scoping
Shireburn Indigo People takes its inputs in the request body rather than as path resources, so scope the agent to the operations it needs, such as listing employees or creating a leave request, and leave out the ones it should not run.
Credential isolation
Your Shireburn Indigo People API key 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 'add a new employee' or 'create a leave request', and Jentic returns the matching Shireburn Indigo People 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 Shireburn Indigo People API through Jentic.
What authentication does the Shireburn Indigo People API use?
The Shireburn Indigo People API uses an API key passed in the `Authorization` header. 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 add a new employee with the Shireburn Indigo People API?
Yes. Use the POST /employees endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Shireburn Indigo People 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 add a new employee through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'add a new employee'. Jentic returns the matching Shireburn Indigo People API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Shireburn Indigo People API have?
The Shireburn Indigo People API exposes 4 endpoints covering employees, leave-requests operations.
Can I limit what my agent is allowed to do with the Shireburn Indigo People API?
Yes. Because Jentic One is self-hosted, you decide which of this API's operations your agent may call and which credentials it may use. Since the Shireburn Indigo People API takes its inputs in the request body rather than as path resources, you scope by operation: you can allow read-only calls like listing employees (GET /employees) or listing leave requests (GET /leave-requests) while withholding writes such as adding an employee (POST /employees) or submitting a leave request (POST /leave-requests). Only the operations you enable are exposed to the agent, and the stored key is injected at execution time under your rules.
For Agents
Programmatically add a new employee, list employees. Covers 4 operations with apiKey authentication.
Use for: I need to add a new employee, I want to employees, Search for submit leave request, Find all leave requests
Not supported: Does not handle payments, communications, or crm - use for hr and recruiting only.
API for HR and employee management. The API exposes 4 endpoints secured with apiKey authentication.
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.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
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>