Skip to content

Reference topics

The API's own reference text, served live: error codes, the redline markup, the document listing, and every edit type.

View as Markdown

GET /v1/reference/{topic} returns one reference topic as text, the same text the MCP server's reference tool returns. It comes from the deployed API itself, so it is always current, which makes it the reference to hand an agent that is building or running your integration.

Base URLhttps://api.versionstory.com
AuthAuthorization: Bearer vs_.... See Authentication
curl -sS https://api.versionstory.com/v1/reference/errors \
  -H "Authorization: Bearer vs_live_..."
{ "topic": "errors", "text": "..." }
topicWhat it covers
errorsWhat each error code means, and what to do about it
redlineThe change markup in a redline's Markdown (format=md)
listingEvery field GET /v1/files/{file_id}/content returns, and how a text selector matches
editsEvery edit type POST /v1/edit takes, with an example of each
local_copyWorking with the user's own copy of a document: recording it, editing it, and replacing it

The call creates nothing and costs nothing against usage, so it is also a cheap way to check that a key works: 200 means it does. An unknown topic is 400 INVALID_REQUEST, and the message lists the topics.