Agent-ready OpenAPI document · curated by JenticProductivityTask Managementbearer, apiKey45 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Start, stop, and edit Kimai timesheets, manage the projects and customers they roll up to, and read recent or running entries from a self-hosted Kimai instance.
Use for: Stop the timesheet that is currently running for me, Create a new timesheet entry for project Acme Onboarding, List timesheet entries from the last 7 days, Find all currently running timesheets across the team
Not supported: Does not handle invoicing, payroll, or expense management - use for time tracking, project, and customer records inside a Kimai instance only.
Jentic publishes the only available OpenAPI specification for Kimai API, keeping it validated and agent-ready. Kimai is an open-source time-tracking application and its REST API exposes the full timesheet, project, customer, activity, user, team, and tag model. Operations cover starting and stopping running timesheets, duplicating or exporting entries, and the standard CRUD surface for projects and customers. Self-hosted Kimai installations expose this API at a host-specific base URL with either bearer or X-AUTH-TOKEN header authentication.
Install Jentic One Beta
Connect the Kimai API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Kimai 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%2Fkimai.org%2Fkimai" | 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%2Fkimai.org%2Fkimai" | 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 Kimai API.
Start and stop running timesheets for the authenticated user
Create timesheet entries with project, activity, and tag attribution
Duplicate and export existing timesheet entries
Maintain the project and customer hierarchy that timesheets roll up to
Read currently running and recent timesheet activities for dashboards
Update timesheet meta fields used for custom reporting
Use Cases
Patterns agents use Kimai API for, with concrete tasks.
★ Stop the running timer at end of day
An automation can list active timesheets with GET /api/timesheets/active and stop them with PATCH /api/timesheets/{id}/stop on a schedule, ensuring no entry is left running overnight. The combined call typically completes in well under a second per user.
Call GET /api/timesheets/active, then PATCH /api/timesheets/{id}/stop for every entry returned.
Daily timesheet creation from a calendar
A morning workflow can read the day's calendar events and POST /api/timesheets for each meeting, attaching the right project and activity. Kimai records the entries against the customer hierarchy so they can be invoiced or reported on without manual entry.
For each calendar event today, POST a timesheet to /api/timesheets with begin, end, project, and activity.
Customer and project hygiene
Operations teams can keep the project list aligned with the active client roster by reading customers via GET /api/customers, comparing them with the source system, and PATCH-ing project records that need to be archived or relabeled. The endpoint set covers the full project and customer CRUD needed for that sync.
Compare GET /api/customers with the master roster and PATCH /api/projects/{id} to archive any project tied to a deactivated customer.
Invoice export pipeline
Before an invoice run, a script can call PATCH /api/timesheets/{id}/export on every billable entry for a customer so that Kimai marks them as exported and they do not appear on the next run. This keeps the billable-versus-exported state consistent across runs.
List timesheets for a customer over the billing period and PATCH /api/timesheets/{id}/export on each one before generating the invoice.
Agent integration via Jentic
A productivity agent can use Jentic to discover the Kimai timesheet operations, load their schemas, and execute them with a vaulted bearer token, letting a user start, stop, or duplicate entries by speaking to the agent.
Search Jentic for 'stop the running Kimai timesheet', load PATCH /api/timesheets/{id}/stop, and execute it for the authenticated user's active entry.
Key Endpoints
45 endpoints — jentic publishes the only available openapi specification for kimai api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/api/timesheets
List timesheet entries
POST
/api/timesheets
Create a timesheet entry
PATCH
/api/timesheets/{id}/stop
Stop a running timesheet
PATCH
/api/timesheets/{id}/restart
Restart a timesheet
GET
/api/timesheets/active
Get currently running timesheets
GET
/api/projects
List projects
GET
/api/customers
List customers
GET
/api/timesheets
List timesheet entries
POST
/api/timesheets
Create a timesheet entry
PATCH
/api/timesheets/{id}/stop
Stop a running timesheet
PATCH
/api/timesheets/{id}/restart
Restart a timesheet
GET
/api/timesheets/active
Get currently running timesheets
GET
/api/projects
List projects
GET
/api/customers
List customers
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.
K
Kimai API
- AI-Aware (B)64/100
87
Foundational Compliance60
Developer Experience & Jentic Compatibility50
AI-Readiness & Agent Experience94
Agent Usability55
Security62
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
87
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
97%
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).
50%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
60
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
48%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
93%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
50
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D+Signals: 4
37%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
62%
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.
55
Security
Trust, risk posture, and security compliance.
Grade: CSignals: 1
55%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
62
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B-Signals: 1
62%
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 Kimai by hand means learning its bearer token or X-AUTH-TOKEN header auth and pointing at your own self-hosted instance host yourself. Through Jentic you install once, import Kimai from the API Directory, store the token once, and your agent calls it.
Permission scoping
Kimai puts the timesheet id in the URL path (/api/timesheets/{id}/stop), so a rule can pin your agent to acting on the timesheets it is given: it can start, stop, or restart those entries and nothing else. You choose the operations it may call, so writes you do not need are not included unless you add them.
Credential isolation
Your Kimai token 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 'start a timesheet' or 'list active time entries', and Jentic returns the matching Kimai 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 Kimai API through Jentic.
Why is there no official OpenAPI spec for Kimai API?
The Kimai project does not publish a hosted OpenAPI specification under its own domain. Jentic generates and maintains this spec so that AI agents and developers can call Kimai 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 Kimai API use?
Kimai supports two schemes: HTTP bearer authentication and a legacy X-AUTH-TOKEN header. Jentic stores the credential in the vault and injects whichever scheme the instance accepts on each request.
Can I stop a running timesheet with the Kimai API?
Yes. Call PATCH /api/timesheets/{id}/stop on the entry you want to stop. To find the entry, list active timers first with GET /api/timesheets/active.
What are the rate limits for the Kimai API?
Kimai is self-hosted, so the rate limit depends on the instance configuration rather than a public quota. Treat list endpoints as paginated reads and avoid polling /api/timesheets/active more often than once a minute.
How do I create a timesheet entry with the Kimai API through Jentic?
Run pip install jentic, search Jentic for 'create a Kimai timesheet entry', load the POST /api/timesheets operation, and execute it with begin, end, project, and activity. Jentic injects the bearer or X-AUTH-TOKEN credential from the vault.
Can I limit what my agent is allowed to do with the Kimai API?
Yes. Because you run Jentic One yourself, your own rules decide which Kimai operations and credentials the agent may use, and Kimai puts the timesheet id in the URL path, so you can pin the agent to acting only on the entries it is given. You might allow just PATCH /api/timesheets/{id}/stop and PATCH /api/timesheets/{id}/restart while withholding writes to /api/projects or /api/customers, so the agent can start, stop, and restart those timesheets and nothing else. The token is injected at execution time and never enters the agent's prompt or logs, and you add write operations only if you explicitly need them.
GET STARTED