API & developer resources

Every Vruum developer resource in one place — the REST API and its OpenAPI spec, the MCP server, authentication with API tokens, the CLI, and the agent discovery endpoints.

This page is the index of Vruum's developer surface. Everything an integration or an AI agent needs lives at a predictable URL, and each resource below says when to use it.

The Vruum API

Vruum's public REST API is the same compound-tool contract exposed over MCP: search, fetch, and manage_* operations covering people, campaigns, outreach, deals, content, research, and settings.

The machine-readable spec:

https://vruum.ai/openapi.json

Also served from the API origin at https://api.vruum.ai/openapi.json. All operations run against https://api.vruum.ai and require bearer authentication (see below). The spec is curated: it describes the supported public surface, so anything in it is safe to build on.

Authentication

Every API and MCP call authenticates with a bearer token. Create one in the Vruum web app under Settings → API tokens, then send it as:

Authorization: Bearer <your-vruum-token>

A token carries exactly your account's authority — the API grants nothing your Vruum login cannot already do.

The Vruum MCP server

The preferred integration surface for AI agents:

https://api.vruum.ai/mcp

MCP exposes the full tool surface with schemas, auth, and discovery built in. Setup per harness, verification, and the MCP-versus-CLI decision are on the MCP page.

The Vruum CLI

The local, scriptable surface for technical setup, CI, local files, and debugging — deterministic stdout and exit codes, --json output:

npm install -g @vruum/cli
vruum login
vruum init

The full command tree is in the CLI reference.

Agent discovery endpoints

For agents that discover capabilities by convention rather than by docs:

Resource	URL
Agent orientation (llms.txt)	`https://vruum.ai/llms.txt`
Full docs corpus for agents	`https://vruum.ai/llms-full.txt`
OpenAPI spec	`https://vruum.ai/openapi.json`
Agent Skills index	`https://vruum.ai/.well-known/agent-skills/index.json`
A2A agent card	`https://vruum.ai/.well-known/agent-card.json`

Every docs page is also available as raw Markdown by appending .md to its URL — for example /docs/api.md is this page.

Which surface should I use?

You are	Use
An AI harness or agent integrating Vruum	The MCP server, authenticated with an API token.
A developer calling Vruum from code	The REST API via the OpenAPI spec.
A technical user scripting locally or in CI	The CLI.
A person setting up Vruum for the first time	Quick Start.