Introduction

Welcome to the Treedis API Documentation!

Getting Started with the API

The Treedis API provides a comprehensive REST API for managing projects, tours, users, virtual staging, and more. All API endpoints are available at the base path /v1/api.

Base URLs

Production: https://api.treedis.com/v1/api
Staging: https://stage-api.treedis.com/v1/api

Authentication

The API supports multiple authentication methods:

API Key: Include X-API-Key header with your API key
Bearer Token: Include Authorization: Bearer {token} header
OAuth2: Use the /oauth2/token endpoint to obtain access tokens

Quick Start

API Quick Start

Get started with the Treedis API in minutes.

Documentation Structure

API Reference

The API Reference provides complete OpenAPI documentation for all endpoints, including:

Authentication endpoints
Project management
User management
Virtual staging
Tours and navigation
And much more

Guides

Explore our guides for detailed information on:

Getting started with the API
Development workflows
Project settings
API client generation

Your Docs, Your Way

Three steps to beautiful docs.

Iterate locally

Edit your docs and watch them update in real time.

Live Previewing

Use the cli for local development.

Add API refs

Include OpenAPI references.

API Client

Auto-generate an API client from your OpenAPI spec.

Make it yours

Write interactive docs and set themes with ease.

Extended Markdown syntax

See all the ways you can write your docs with our custom syntax.

Diving In

power of directives code samples images