For developers

API endpoints and resources for integration and monitoring.

Try the API

Call a read-only endpoint from your browser. Response and timing are shown below.

API endpoints

Examples: curl -s https://hito.run/api/health · curl -s https://hito.run/api/status · curl -s https://hito.run/api/brains

  • GET /apiAPI root: service, version, _links to key endpoints
  • GET /api/healthHealth check: status, service, timestamp
  • GET /api/versionApp version and service name
  • GET /api/statusCombined health + version for monitoring
  • GET /api/pingConnectivity check: { pong: true }
  • GET /api/brainsList brains: { brains: [{ id, name, description }, ...] }
  • GET /api/officesDemo offices with hitos: { offices: OfficeWithHito[] }
  • GET /api/openapiOpenAPI 3.0 spec (machine-readable API docs)
  • GET /api/localesSupported locales for i18n: { locales: [{ code, name, default }] }
  • GET /api/capabilitiesFeature discovery: { capabilities: { openapi, locales, rateLimitHeaders, schemas, webhooks, auth } }
  • GET /api/schemasList JSON Schema type names: { schemas: ["Office", "Hito", "Brain", "Integration", "Health", "Error"] }
  • GET /api/schemas/[type]JSON Schema for Office, Hito, Brain, Integration, Health, or Error (validation)
  • GET /api/errorsError code catalog: { errors: [{ code, message, httpStatus }] }
  • GET /api/changelogAPI releases: { releases: [{ version, date, summary }] }
  • GET /api/usageUsage stub: period, requestsUsed, requestsLimit (future billing)
  • GET /api/limitsRate limit policy: limit, windowSeconds

Resources

  • Documentation — Index of repo docs (API, architecture, deploy)
  • Sitemap — Public pages and key resources in one list
  • sitemap.xml — XML sitemap for crawlers
  • robots.txt — Crawler rules
  • Status page — Service status and version
  • /ping · /health · /version — Redirect to GET /api/ping, GET /api/health, GET /api/version
  • OpenAPI spec — GET /api/openapi returns OpenAPI 3.0 JSON for codegen and tooling. View in Swagger Editor (opens spec in browser).
  • All API responses include X-RateLimit-Limit, X-RateLimit-Remaining, Link: </api/openapi>; rel="describedby", and CORS Access-Control-Allow-Origin: * (callable from browsers).
  • Webhooks & SSE — Planned for status updates and events (see Roadmap Next).
  • API reference — full spec in repo: docs/api.md (sample curl calls and Monitoring section).

DocsStatusRoadmapChangelogSecurityContact