{"id":49360683,"url":"https://github.com/jentic/api-ai-readiness-framework","last_synced_at":"2026-04-27T16:30:51.869Z","repository":{"id":349410510,"uuid":"1102420135","full_name":"jentic/api-ai-readiness-framework","owner":"jentic","description":"A technical specification for the Jentic API AI-Readiness Framework (JAIRF). Defines the signals, dimensions, scoring model, and normalisation rules used to evaluate how interpretable, operable, and trustworthy APIs are for AI systems and autonomous agents.","archived":false,"fork":false,"pushed_at":"2026-04-05T19:13:13.000Z","size":1556,"stargazers_count":12,"open_issues_count":9,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-05T21:15:38.029Z","etag":null,"topics":["ai-readiness","ai-readiness-check","api-scoring","apis-to-ai","openapi"],"latest_commit_sha":null,"homepage":"https://docs.jentic.com/reference/api-readiness-framework/overview/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jentic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":"MAINTAINERS.md","copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-23T12:37:49.000Z","updated_at":"2026-04-05T19:13:12.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jentic/api-ai-readiness-framework","commit_stats":null,"previous_names":["jentic/api-ai-readiness-framework"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/jentic/api-ai-readiness-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jentic%2Fapi-ai-readiness-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jentic%2Fapi-ai-readiness-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jentic%2Fapi-ai-readiness-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jentic%2Fapi-ai-readiness-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jentic","download_url":"https://codeload.github.com/jentic/api-ai-readiness-framework/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jentic%2Fapi-ai-readiness-framework/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32345802,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-readiness","ai-readiness-check","api-scoring","apis-to-ai","openapi"],"created_at":"2026-04-27T16:30:50.868Z","updated_at":"2026-04-27T16:30:51.862Z","avatar_url":"https://github.com/jentic.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jentic API AI-Readiness Framework (JAIRF)\n\nA syntactically valid OpenAPI description doesn't guarantee your API is ready for AI systems. Validity ensures conformance to the spec's grammar—but AI agents need APIs that express intent clearly and can be reasoned over safely by machines.\n\nThis repository contains the **Jentic API AI-Readiness Framework (JAIRF)**: a standards-aligned specification for evaluating how well APIs serve AI agents across six critical dimensions.\n\n**What's included:**\n\n- **Framework specification** defining evaluation criteria and scoring methodology\n- **Reference scoring algorithms** for consistent, automated assessment\n- **Guidance for implementers** to improve API AI-readiness\n\n## The Six Dimensions\n\nJAIRF evaluates APIs across these areas:\n\n1. **Foundational Compliance** – Structural validity and standards conformance\n2. **Developer Experience \u0026 Tooling Compatibility** – Documentation quality and tooling support\n3. **AI-Readiness \u0026 Agent Experience** – Semantic clarity and context sufficiency for AI systems\n4. **Agent Usability \u0026 Orchestration** – Safe, predictable multi-step operations\n5. **Security \u0026 Governance** – Authentication, authorization, and trust mechanisms\n6. **AI Discoverability** – How easily AI systems can find and understand your API\n\nSmall, targeted improvements in these areas produce outsized gains for both human developers and AI agents.\n\n## Score Your APIs\n\nSee AI-readiness scoring in action at [jentic.com/scorecard](https://jentic.com/scorecard). Upload your OpenAPI specification and receive an instant assessment across all six dimensions.\n\n![API AI-Readiness Scorecard](assets/scorecard-preview.jpg)\n\nSample Top-level Scorecard:\n\n![Sample Scorecard](assets/sample-score-card-header.png)\n\n## Publishing\n\nChanges to `docs/specification/spec.md` on the `main` branch automatically publish to [jentic-docs](https://github.com/jentic/jentic-docs) via GitHub Actions. The workflow creates a PR with the updated specification.\n\nYou can view the published docs at [https://docs.jentic.com](https://docs.jentic.com/reference/api-readiness-framework/overview/).\n\n\n## Maintainers\n\nSee [MAINTAINERS.md](./MAINTAINERS.md).\n\n## Contributing\n\nWe welcome contributions from the community. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on reporting issues, submitting pull requests, and coding standards.\n\nAll contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## Building Upon the Jentic API AI-Readiness Framework\n\nIf you build tools, extensions, or derived works based on this framework, please credit the Jentic API AI-Readiness Framework (JAIRF) and link back to this repository. This helps maintain the framework's visibility, accuracy, and supports the broader API and AI community.\n\nThe framework is licensed under [Apache License 2.0](LICENSE), which permits commercial and non-commercial use with proper attribution.\n\n## License\n\nThis project is licensed under the [Apache License 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjentic%2Fapi-ai-readiness-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjentic%2Fapi-ai-readiness-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjentic%2Fapi-ai-readiness-framework/lists"}