VANI · DEVELOPER PLATFORM

Build on the infinite canvas

Here's everything you need to get started with the Vani API. Whether you're building integrations or automating workflows, this guide has you covered.

Quick start → Browse the API

171operations

14OAS documents

7data centres

3.1.0OpenAPI

Core API

The stable REST surface — spaces, boards, people and the objects on the canvas.

Editions8 ops

Edition-level resources: the edition itself, its subscription, join requests, and templates.

Editions · Subscription · Templates

Teams15 ops

Teams within an edition, their members, join requests, and role lookups.

Teams · Team Members · Team Requests

Spaces17 ops

Spaces (projects) within an edition, their members, join requests, and role lookups.

Spaces · Space Members · Space Requests

Zones12 ops

Zones (documents) within a space: lifecycle, metadata, versioning, and per-zone sharing.

Zones · Zone Versions · Conditional Sharing

Elements34 ops

Create, read, update, and delete the objects on a zone canvas: shapes, connectors, group shapes, frames, and their text.

Shapes · Connectors · Group Shapes · Frames · Shapes on Frame · Connectors on Frame · Group Shapes on Frame · Frames on Frame · Element Text

Search5 ops

Content search across a team's zones, frames, comments, and members.

External Share6 ops

Publish a space externally and manage the resulting public share.

External Share

Zone Operations TRANSITIONAL

Act on what is inside a zone — build structures, place and align objects, traverse relationships, and edit tables and text. Served under /sdk/v1/. Working and supported; paths may change when REST equivalents ship.

Structures6 ops

Build whole structures in one call — mindmaps, flowcharts, kanban boards, stacks, and tables.

Structured Creation

Layout & Placement26 ops

Deterministic placement, alignment, tidy layout, spatial queries, and connector routing.

Anchoring · Spatial Search · Connections

Navigation & Relationships13 ops

Traverse the zone hierarchy, resolve relationships, and navigate visually between objects.

Relationships · Traversal · Visual Navigation

Tables23 ops

Cell, row, and column operations on table objects, and typed database_table records and schema.

Tables · Database Tables

Text2 ops

Read and mutate text on any text-bearing object, including styling.

Text

Data4 ops

Low-level batch read and mutation escape hatch over zones, frames, and objects.

Data

OpenAPI files JSON | YAML

14 self-contained OAS 3.1.0 documents — one per area, plus a bundle. Generate a client in any language, or download a single area's spec from its page.

# github.com/zoho/vani-oas openapi-generator generate -i v1/editions.json -g python

Authentication

OAuth 2.0 through Zoho Accounts. Every operation declares exactly the scopes it needs — request only those.

Vani.editions.READVani.editions.CREATEVani.editions.UPDATEVani.teams.READ