Buildwithorbitbuildwithorbit.ai
Buildwithorbit's API program is performing exceptionally well across all evaluated dimensions — partner discoverability, design clarity, documentation quality, and agent readiness are all at the highest level. The only remaining opportunities are modest refinements to ensure agents and partners always have machine-readable, runnable context at their fingertips.
API DesignA clean, typed, well-governed API contract agents can reason about4 pass1 warn0 fail96A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable, versioned contractvia spec | 25/25 | The API declares version "1.0.0" and uses url-based versioning, so an agent can pin to a stable contract. Investigated: spec 100%, docs 100%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| pass | Auth declared & discoverablevia spec | 25/25 | This API requires no credentials and says so — the docs state "Orbit does not require authentication." (docs). An agent can call it directly. Investigated: spec 100%, docs 100%. | Agents can only call an API when they can determine its auth posture — a declared scheme, or an explicit statement that none is required. |
| warn | Schema coverage & depthvia spec | 20.8/25 | The request body of POST /v1/integrate has a structured shape (more than 5 top-level fields, or a nested object / array-of-objects field), which is harder for an agent to fill correctly. Investigated: spec 83%. Fix: Flatten the request body, or document each field's shape with a worked example. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| pass | Example coveragevia spec | 10/10 | 100% of parameters and responses (13 of 13) include example values, grounding an agent in real payload shapes. Investigated: spec 100%, docs 100%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples5 pass0 warn0 fail100A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | The API requires no credentials (the docs state "Orbit does not require authentication." (docs)), so there is nothing to sign up for and no sales gate to clear. Investigated: docs 100%. | A first call without a human in the loop — self-serve credentials, a free tier, or an API that needs none. |
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://www.buildwithorbit.ai/docs/get-started/welcome includes a runnable first-call code sample. 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 appear on 1 of 4 sampled docs pages across 1 language(s), but broader multi-language coverage is missing. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | 100% of operations and parameters carry substantive descriptions (2 of 2 ops, 4 of 4 params), the main semantic cue an agent relies on. Investigated: spec 100%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog is documented on the docs site at https://www.buildwithorbit.ai/changelog, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs3 pass1 warn0 fail98A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Docs reachable, not hard auth-gatedvia docs | 30/30 | All 11 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 | Same-origin links point to HTML and no markdown alternatives detected. Investigated: docs 94%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (llmstxt/buildwithorbit_ai_llms_txt, 151 snippets). Investigated: docs 100%, sdk 0%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| pass | Crawlable / AEOvia wellknown | 12/12 | robots.txt lets all monitored AI crawlers reach the docs paths. Investigated: wellknown 100%. | 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 docs3 pass2 warn0 fail95A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | Documents 4 distinct 4xx/5xx error response codes, so an agent can branch on specific failures instead of guessing. Investigated: docs 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| pass | Operation purpose clarityvia spec | 25/25 | 100% of operations (2 of 2) have both a clear summary and a descriptive name, so an agent can pick the right endpoint. Investigated: spec 100%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Agent-navigable, token-efficient docsvia docs | 20.6/22 | 2 of 9 pages have substantive content differences between markdown and HTML (avg 12% missing). Investigated: docs 94%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| pass | Agent instructions file (AGENTS.md)via wellknown | 10/10 | Agent instructions file (AGENTS.md) found at https://buildwithorbit.ai/AGENTS.md. Investigated: wellknown 100%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| warn | Docs structured datavia docs | 4/8 | JSON-LD Article markup covers 4 of 4 assessed pages (100%), but no page carries dateModified, so answer engines can't tell how current the docs are. Investigated: docs 50%. Fix: Add dateModified to the existing JSON-LD so answer engines can tell how current each page is. | 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 | Description consistency across surfaces | —/7 | Only 1 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 them3 pass1 warn0 fail95A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia spec | 27/27 | 100% of mutating operations (2 of 2) document idempotency, so an agent's retries won't create duplicates. Investigated: spec 100%, docs 100%. | Documented idempotency lets agents retry safely. |
| pass | Rate-limit signalingvia spec | 22/22 | Documents 4 distinct rate-limit response headers, so an agent can back off before getting throttled. Investigated: spec 100%, docs 100%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| pass | Pagination documented & consistentvia spec | 22/22 | Pagination parameters are present on the 2 list endpoint(s), so an agent can page through results. Investigated: spec 100%, docs 100%. | Consistent, documented pagination lets agents traverse collections. |
| warn | Runnable collection with test scriptsvia platform | 4.5/9 | No test scripts found in the workspace's public collections, so an agent can't use them to verify API behavior. Investigated: platform 50%. Fix: Add pm.test() assertions so the collection can be used as an agent-runnable test suite. | A public, maintained collection with assertions is runnable truth agents validate against. |
| na | Sandbox separation | —/20 | No surface produced evidence for this capability in this run. | An isolated environment lets agents exercise destructive operations safely. |
Resources Discovered
The public resources we found for Buildwithorbit — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (151) |
|---|---|
| APIs analyzed | 1 — API Reference |