Skip to content

Loading…

Documentation for AI agents

Read any documentation page as Markdown or plain text, or download the complete API reference.

On this page

Every documentation page is available as HTML, Markdown and plain text. These are representations of the same public content: the endpoint descriptions, parameters, request bodies, responses and examples come from the same OpenAPI snapshot used by the website.

Request a page as Markdown

Send Accept: text/markdown to the normal documentation URL:

Terminal
curl -H 'Accept: text/markdown' \
  'https://api-docs.vestta.io/properties/list'

The response uses Content-Type: text/markdown; charset=utf-8. The URL stays the same. HTML remains the default for browsers and clients that do not explicitly request Markdown or plain text. Quality weights in Accept are respected; q=0 excludes a format.

Direct Markdown and text URLs

Append .md to a page path, or .txt for the same text with Content-Type: text/plain:

Text
https://api-docs.vestta.io/index.md
https://api-docs.vestta.io/authentication.md
https://api-docs.vestta.io/properties/list.md
https://api-docs.vestta.io/properties/list.txt

The homepage uses index.md or index.txt. Direct URLs also work for clients that cannot configure request headers. They link back to the canonical HTML page; the HTML pages remain the search-engine sitemap entries.

Discover or download the documentation

  • llms.txt: the documentation index and links to individual Markdown pages.
  • llms-full.txt: the complete authored documentation with OpenAPI components expanded.
  • openapi.json: the machine-readable API contract.

Start with the index and retrieve the pages needed for your task. Use the full file when your client has enough context for the entire reference. HTML pages advertise their alternatives using link rel="alternate"; HTTP responses include Vary: Accept and canonical links.

Scope and authentication

The documentation is public and needs no API key. Actual calls to https://api.vestta.io/v1 still need the documented API key and scopes. Markdown access does not grant access to CRM accounts or private data, and does not execute the actions described in examples.

The public marketing website offers the same reading formats; see Vestta for AI agents. The CRM application is outside this feature.