v1.0.0

Treedis API

The Treedis API is a REST API for managing projects, tours, users, virtual staging, workspaces, and more.

Base URL

All endpoints are served from:

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

Most endpoints live under the /v1/api path; the v2 public API (Connected Workers) lives under /v2/api.

Authentication

The API uses OAuth2 as the primary authentication method. A legacy API key is also accepted.

  1. OAuth2 (recommended) — exchange your client credentials at POST /v1/api/oauth2/token for a short-lived access token, then send it as Authorization: Bearer {access_token}.
  2. API key (legacy) — send your key in the X-API-Key header.

See the Authentication guide for the full OAuth2 flow, scopes, and token rotation.

Response Format

Successful responses are wrapped in a consistent envelope:

{ "status": 200, "message": "Success", "timestamp": 1716146262053, "data": { } }

Rate Limiting

The OAuth2 token endpoint is rate limited to 5 attempts per 60 seconds; exceeding it blocks further attempts for 30 minutes.

Production

Client Libraries