Skip to content
Platform API— browse docs
On this page

Overview

The vvd platform API — create worlds and edit world content from code.

vvd is a world-building and storytelling platform. The platform API lets you do everything the app does — create worlds, add documents (cards, timelines, maps…), search, manage eras and projects — from outside the UI, with your own scripts or any MCP client.

There is one engine behind three doors:

  • REST API — https://vvd.world/api/v1, described by OpenAPI.
  • MCP server — https://vvd.world/api/mcp, for any MCP client.
  • CLI — the vvd command-line tool.

They are the same operations. An MCP tool call, a REST request, and a CLI command all run the identical server-side operation, authenticated the same way, enforcing the same world permissions.

Plans

Building tools and apps with the CLI is free on every plan. Reading or editing a world's content through the REST API, MCP, or the CLI is part of the Pro and Studio plans — on other plans those operations answer with an upgrade message. See pricing.

Everything acts as you

A credential — an API key or an OAuth connection — acts as your account. Anything you can do in the app, it can do; anything you can't, it can't. If you're only a viewer on a world, the API lets you read it but not write it. Remove yourself from a world and every credential loses access to it automatically. There is no separate permission system to keep in sync — your world memberships are the authority.

Start here