Today, Vantage is announcing the migration of the Vantage API documentation to a new unified documentation environment at https://docs.vantage.sh/api. This move consolidates API and product documentation in a single location, providing developers with an enhanced, interactive experience and access to AI-powered assistance.

Previously, Vantage's product documentation was hosted on an open-source solution, while the API documentation was separately hosted on readme.io. This separation meant developers had to navigate between two different sites to access the information they needed. After migrating our product documentation to Mintlify, we recognized the opportunity to bring the API documentation to the same platform, creating a unified experience while enabling developers to access Mintlify's advanced features, like context-aware guidance for understanding API requests and responses.

Now, with this documentation update, developers gain:

• Unified Documentation Experience: Access API and product documentation in a single, consistent environment.
• AI-Powered Assistance: Understand code and API requests/responses through the built-in AI Assistant.
• Context-Aware Support: Use the Docs MCP and Vantage FinOps Agent to understand API endpoints and responses in the context of your specific use case. This makes it even easier to create scripts and build programmatic access to Vantage.

The API itself (https://api.vantage.sh/v2/) remains unchanged. Customers only need to update their documentation bookmarks to the new URL. The previous documentation site at readme.io will remain available for a transition period before being retired. To get started, visit the API documentation site at: https://docs.vantage.sh/api.

Frequently Asked Questions

1. What’s being announced?

We moved the API documentation to provide a unified experience with our product documentation and enable developers to take advantage of advanced features, like context-aware AI assistance. This consolidation makes it easier to discover related information and get contextual help while building integrations.

2. Do I need to update my API integrations?

No. The API itself (https://api.vantage.sh/v2/) has not changed. Only the documentation URL has moved. Your existing integrations will continue to work without any modifications.

3. How much does this cost?

The Vantage API and API docs remain free to use for all users. You only need a valid API token, which you can generate from your account settings. See the Authentication page for details on how to create an API key.

4. What happened to the old documentation site?

The previous documentation at vantage.readme.io will remain accessible for a short transition period to give customers time to update their bookmarks. A banner will be displayed at the top of the homepage of the site, linking to the new site. We recommend updating to the new URL at https://docs.vantage.sh/api to access the latest features and capabilities.

5. How do I use the new site and make sample API calls?

Browse all API endpoints alphabetically in the left navigation menu. Each endpoint page features a “Try it” button at the top of the page that opens an interactive API playground. Enter your Vantage API token to test API calls directly from your browser.

Keep in mind that the playground makes real API calls to your Vantage account using your live Vantage data. Exercise caution when testing endpoints that create, modify, or delete Vantage resources.

In the video below, the user opens the API playground and enters their access token. As they fill in parameters on the left, the information populates in the request on the right. Click Send to complete the API call.

After a call is sent, the response—either a successful response or any errors—is displayed on the top right, with your original call information displayed on the bottom.

6. What new capabilities does the unified documentation provide?

The new site provides access to AI assistance for code explanations of API requests and responses. In the video below, the user gets assistance to understand a particular endpoint request.

The site also integrates with the Vantage FinOps Agent through the Docs MCP for context-aware guidance. You can also use AI agents like Claude or Cursor to help answer questions via the Docs MCP integration as well. The example below shows a user asking Claude how to use a particular endpoint, with a link provided directly to the endpoint docs page.

7. Where can I find additional resources to get started with the API?

We provide a comprehensive quickstart guide to help you get started with the Vantage API.