Box Platform API OpenAPI spec score
Octri scored the public spec at https://raw.githubusercontent.com/box/box-openapi/main/openapi.json for what a code generator can do with it. This is a reading of the document, not a grade of the API.
297 operations · 316 models · 73 tags · OpenAPI 3.0.2
Scored 29 October 2026 · fingerprint 47cdf4bcbc7c… · spec version 2024.0 · server api.box.com
Document last changed 29 October 2026.
Where the points went
Every rule, heaviest first, with what it cost this document, how much of the surface it touched, and where. The rule id links to what that rule checks.
| Rule | Weight | Result | Surface | Locations |
|---|---|---|---|---|
| Successful responses declare a schemaresponse-schema | 2.0 | 0.5 lost | 9 of 297 operations | DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}GET /files/{file_id}/contentPOST /sign_requests/{sign_request_id}/resendand 6 more |
| Shared models live in components and are $ref'dshared-schemas-referenced | 2.0 | Clean | 297 operations clean | Nothing found |
| Generated public names do not collideoperation-id-unique | 2.0 | Clean | 297 operations clean | Nothing found |
| Every path placeholder has a parameterpath-parameters-declared | 1.5 | Clean | 297 operations clean | Nothing found |
| Every operation declares an operationIdoperation-id-present | 1.0 | Clean | 297 operations clean | Nothing found |
| operationIds read as method namesoperation-id-naming | 1.0 | 0.2 lost | 1 of 297 operations | GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options |
| Operations carry a summary or descriptionoperation-documented | 1.0 | Clean | 297 operations clean | Nothing found |
| Request bodies are documentedrequest-body-documented | 1.0 | 0.3 lost | 35 of 297 operations | POST /oauth2/revokePOST /sign_requestsPUT /ai_agents/{agent_id}and 32 more |
| Failure responses are declarederror-responses | 1.0 | Clean | 297 operations clean | Nothing found |
| Operations are taggedoperation-tagged | 1.0 | Clean | 297 operations clean | Nothing found |
| No duplicate or equivalent pathsduplicate-paths | 1.0 | Clean | 187 paths clean | Nothing found |
| Authentication is describedsecurity-declared | 1.0 | Clean | Declared | Nothing found |
| Parameters explain their purposeparameters-documented | 0.75 | Clean | 297 operations clean | Nothing found |
| A server URL is declaredserver-url | 0.5 | Clean | Declared | Nothing found |
What 9.1 means for an SDK
A strong reading, and the three rules that decide most of it.
A generator has what it needs here: typed methods, named models and doc comments that say something. What is left is polish, and it can wait until after the first release.
Three rules carry six of the 10 points between them. On this document they took 0.45.
−0.5
Successful responses declare a schema
9 of 297 operations
Clean
Shared models live in components and are $ref'd
297 operations clean
Clean
Generated public names do not collide
297 operations clean
What to change first
Every rule that deducted, in the order they cost.
0.5 lost
Successful responses declare a schema
Give the success response a schema, or a $ref to one in components. A 204 needs nothing.
Inside Octri this one has a one-click fix.
0.2 lost
operationIds read as method names
Name the id for the action, not the route. The audit suggests one per operation and can apply it.
Inside Octri this one has a one-click fix.
0.3 lost
Request bodies are documented
Describe the body, or the fields inside it. Field-level prose is the one that reaches the SDK's arguments.
Inside Octri this one has a one-click fix.
Where to go next
- Score your own spec The same fourteen rules, on any public URL. No account, and the spec is not kept.
- OpenAPI to a TypeScript SDK Published to npm, with the type definitions generated from your spec.
- OpenAPI to an MCP server The same endpoints, as tools an agent can call.
- How SDK Studio shapes a client Naming, hooks and packaging, decided before ten runtimes are built.
The spec at raw.githubusercontent.com is public. Octri keeps the `info` block, the score, and up to five sample finding locations per rule. The document itself is not stored and is not served from here. The audit predicts what an SDK generator can do with the description; it is not a security review, an uptime measurement or a critique of the API’s design. This page is not affiliated with Box Platform API or Box, Inc.