Airopsairops.com
Airops's API program shows strong discoverability and developer experience fundamentals, but partners and their AI agents are being let down by two critical gaps: agent-facing context is almost entirely absent, and the API's security posture lacks the governance signals partners require before committing to an integration. Closing the agent-readiness gap — structured docs, an AGENTS.md file, and a runnable collection with test scripts — alongside publishing a changelog and tightening security hygiene will convert partner interest into durable, confident integrations.
API DesignA clean, typed, well-governed API contract agents can reason about1 pass1 warn1 fail68C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Schema coverage & depthvia sdk | 20.2/25 | 5 of 23 public signatures use loose types (anyTypeRatio=0.217). Investigated: sdk 81%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Example coveragevia docs | 10/10 | Code samples present on 2/20 pages across 2 language(s); broader multi-language coverage missing. Investigated: docs 100%, sdk 100%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
| fail | Security & governance hygienevia wellknown | 0/15 | No security.txt at /.well-known/security.txt or /security.txt. Investigated: wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| na | Machine-readable, versioned contract | —/25 | No surface produced evidence for this capability in this run. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| na | Auth declared & discoverable | —/25 | No surface produced evidence for this capability in this run. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples3 pass1 warn1 fail85A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Self-service signup at https://app.airops.com/users/sign_up?_gl=1*1mnp9mj*_gcl_au*MTY1MTYwNTgxMC4xNzYwMDQyNTY2*_ga*MTA4NDA3MDIwMS4xNzYwMDQyNTY2*_ga_41PB5YFX2D*czE3NjMwNDUwMDQkbzk5JGcwJHQxNzYzMDQ1MDUzJGoxMSRsMCRoMA..*_ga_2MG5HD0G0Y*czE3NjMwNDUwMDQkbzk5JGcwJHQxNzYzMDQ1MDUzJGoxMSRsMCRoMA..; free tier / sandbox documented. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://docs.airops.com/getting-started has a runnable sample in the .md variant (https://docs.airops.com/getting-started.md). Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Code samples in docsvia docs | 18/18 | Code samples present on 2/20 pages across 2 language(s); broader multi-language coverage missing. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| warn | Description completenessvia sdk | 10/15 | 3/9 operations lack a description. Investigated: sdk 67%. | Complete descriptions are the context humans and agents need to use endpoints. |
| fail | Changelog publishedvia sdk | 0/13 | Official SDKs stale: newest activity 713 days ago. Investigated: sdk 0%. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs2 pass2 warn0 fail96A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Docs reachable, not hard auth-gatedvia docs | 30/30 | All 50 sampled pages are publicly accessible. Investigated: docs 100%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| warn | llms.txt present, valid & comprehensivevia docs | 28.1/30 | llms.txt contains parseable links but doesn't fully follow the proposed structure: https://docs.airops.com/llms.txt: No blockquote summary found. Investigated: docs 94%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| pass | Registry & SDK presencevia cli | 28/28 | CLI documented with install instructions (download, download, download, download). Investigated: cli 100%, sdk 75%, docs 0%, mcp 0%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | Crawlable / AEOvia wellknown | 9/12 | Sitemap present (2 entries) but carries no lastmod values. Investigated: wellknown 75%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs0 pass2 warn2 fail59D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Agent-navigable, token-efficient docsvia docs | 17.6/22 | 4 of 50 pages have substantive content differences between markdown and HTML (avg 6% missing). Investigated: docs 80%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Machine-readable errors (RFC 9457)via sdk | 14/28 | Single base error "ApiError" present, but only 1 subclass found; a richer hierarchy lets consumers catch narrowly. Investigated: sdk 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| fail | Agent instructions file (AGENTS.md)via wellknown | 0/10 | No AGENTS.md at the site root or /.well-known/. Investigated: wellknown 0%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| fail | Docs structured datavia docs | 0/8 | Neither JSON-LD nor OpenGraph/meta tags detected across 1 assessed pages (1 JS-rendered). Investigated: docs 0%. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| na | Operation purpose clarity | —/25 | No surface produced evidence for this capability in this run. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| na | Description consistency across surfaces | —/7 | Only 0 surface description(s) with ≥6 tokens available; need at least 2 to compare. | Every surface tells the same story about what the product is. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them1 pass1 warn1 fail72B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia sdk | 27/27 | Built-in retry machinery is present (grep-derived). Investigated: sdk 100%. | Documented idempotency lets agents retry safely. |
| warn | Sandbox separationvia sdk | 10/20 | No test-mode flag or sandbox environment is exposed. Investigated: sdk 50%. | An isolated environment lets agents exercise destructive operations safely. |
| fail | Runnable collection with test scriptsvia platform | 0/9 | No public Postman workspace discovered for the org. Investigated: platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| na | Rate-limit signaling | —/22 | No surface produced evidence for this capability in this run. | Machine-readable rate-limit headers let agents throttle adaptively. |
| na | Pagination documented & consistent | —/22 | No surface produced evidence for this capability in this run. | Consistent, documented pagination lets agents traverse collections. |