Skip to main content

​
Use the docs with AI

Vantr developer docs are built for people and AI tools. Use the same published docs site for page Markdown, the OpenAPI contract, the hosted search MCP server, and the agent skill.
Set DOCS_URL to the published Vantr Developer Docs root before using the examples on this page.

OpenAPI contract

Generate clients and verify endpoint behavior from the committed v2 spec.

Docs MCP server

Connect an AI tool to search and retrieve current docs content as Markdown.

Documentation index

Give agents a compact directory of available pages and descriptions.

Agent skill

Give agents product-specific constraints for building Vantr v2 API integrations.

​
One-click context

Use this prompt when configuring an AI coding tool for Vantr API work.

Give an AI coding tool current Vantr v2 API context.

Open in Cursor

​
What each endpoint is for

Every page is available as Markdown by appending .md to its URL. Use this when an AI tool needs one page as clean source context.
Example

Start from the spec

Read /openapi/v2.json before writing client code, request payloads, or endpoint mappings.

Read the guide page

Pair the API reference with the guide for authentication, scopes, conventions, errors, and the resource workflow you are building.

Use the contextual menu

Copy a page as Markdown, open it as .md, send it to ChatGPT or Claude, download the spec, or copy the docs MCP server URL from the page header.

Keep secrets server-side

Treat client secrets and bearer tokens as server-only credentials. Never place them in browser code, mobile apps, logs, or shared prompts.

Generate clients

Generate typed clients from the published OpenAPI spec.

Authentication

Choose Basic auth, client headers, or OAuth bearer tokens.

API conventions

Understand pagination, envelopes, casing, and archive behavior.