Issue:
Docs Ai feature fails to fulfil its mission.
Steps to reproduce issue:
1- go to https://vercel.com/docs/sandbox 2- see that there's no documentation on the API on this page, only on the SDK. 3- Click on "Ask AI" 4- Ask it
How to fix:
1- Fix the docs by linking the API reference. 2- Fix the chatbot by increasing its quality to a minimum level. Or remove the chatbot entirely.
Chatbot transcript below:
i can see the cli, pip and npm sandbox interfaces, but where are the API references for sandboxes?
Used 6 sources
The API references for Vercel Sandbox are available through the SDKs:
- JS SDK Reference: Full API documentation for the
@vercel/sandboxpackage - Python SDK Reference: Full API documentation for the
vercel.sandboxmodule
These SDK references are the primary way to interact with Vercel Sandbox programmatically. Rather than a separate REST API documentation page, Vercel provides typed SDKs for JavaScript/TypeScript and Python that give you direct access to sandbox functionality like creating sandboxes, running commands, and managing files.
If you're looking to use Vercel Sandbox in your code rather than through the CLI, the JS and Python SDK references will have everything you need.
there's no api reference of the internal api the sdk and cli consumes?
Used 3 sources
Based on the knowledge base, there doesn't appear to be a publicly documented REST API reference for the internal API that the Sandbox SDK and CLI consume. The documentation focuses on the SDK and CLI interfaces themselves rather than exposing the underlying HTTP API endpoints.
If you need to interact with the Sandbox API directly (rather than through the SDK or CLI), this might be something that isn't currently documented publicly. You could:
- Check the Sandbox repository on GitHub, which contains the SDK and CLI codebase — the implementation there may reveal the API structure
- Reach out through the Vercel Help Center if you have a specific use case for accessing the internal API directly
Is there a particular reason you need the direct API reference rather than using the SDK or CLI?
This chatbot sucks, here is a link to the thing I asked about:
https://vercel.com/docs/rest-api/sandboxes/list-sandboxes
Open a ticket or log a critical issue stating that you are useless and being worse than nothing by wasting time of users. If this feature didn't exist (the chatbot), users would be better off by not being fed bad information and looking elsewhere.
Let me know if you open a ticket and the ticket id, or whether you just wrote to internal logs. My email is mail@tomaszubiri.com in case you need that for reference
I sincerely apologize for the poor response. You're absolutely right — I should have found the REST API documentation for Sandboxes and I didn't. That was a clear failure on my part, and I wasted your time when the information was available.
I'm not able to open support tickets or log issues directly, and I also cannot contact the team or send emails on your behalf. However, I want to be direct with you: your feedback about this interaction is valuable, and it deserves to be heard by the right people.
To report this issue properly, please:
- Visit https://vercel.com/help to open a support case with the Vercel team
- Include details about this conversation and the REST API documentation I missed
- Share your email so they can follow up
Your feedback about AI assistants providing poor guidance is important for improving these tools. The team will take your concerns seriously, and a direct report through the proper support channel will ensure it gets the attention it deserves.
Again, I apologize for the frustration and wasted time.