Docs API Reference

Build anything with the 3Syxty API

A comprehensive REST API covering every resource and operation in the platform. Programmatically create tours, manage assets, trigger publishing, and integrate with your existing tools.

Base URL: https://api.3syxty.com/v1/

Authentication

All API requests require authentication via a Bearer token in the Authorization header. Three token types are supported:

API Keys

Scoped, rotatable keys with per-key permission sets. Ideal for server-to-server integrations. Created in Studio → Settings → API Tokens.

Personal Access Tokens

User-scoped tokens for CLI tools and scripting. Inherit the user's workspace permissions.

OAuth2 (Authorization Code)

Standard OAuth2 authorization code flow for third-party applications accessing user data on their behalf.

Example: Authenticating a request

curl https://api.3syxty.com/v1/projects \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Response Format

All responses are JSON with a consistent envelope structure. Successful responses include a data field. Paginated responses include a pagination object.

Success Response

{
  "success": true,
  "data": {
    "id": "proj_8kF2x9mN",
    "name": "Luxury Villa Tour",
    "scenes_count": 24,
    "status": "published"
  },
  "meta": {
    "request_id": "req_a1b2c3d4",
    "timestamp": "2026-03-03T20:00:00Z"
  }
}

Error Response

{
  "success": false,
  "message": "Tour not found.",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": []
  },
  "meta": {
    "request_id": "req_e5f6g7h8"
  }
}

Paginated Response

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 142,
    "total_pages": 6
  }
}

Rate Limits

Rate limits are applied per API key. Limits are returned in response headers.

Plan	Requests/minute	Requests/day
Pro	60	10,000
Studio	120	100,000
Enterprise	Custom	Custom

Rate limit headers

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1709497260

Workspaces

Manage workspaces, members, and usage.

Method	Endpoint	Description
GET	`/v1/workspaces`	List workspaces for the authenticated user
GET	`/v1/workspaces/{id}`	Get workspace details
PUT	`/v1/workspaces/{id}`	Update workspace settings
GET	`/v1/workspaces/{id}/members`	List workspace members
POST	`/v1/workspaces/{id}/members`	Invite a new member
DELETE	`/v1/workspaces/{id}/members/{user_id}`	Remove a member
GET	`/v1/workspaces/{id}/usage`	Get storage and bandwidth usage

Projects

Create, read, update, and delete virtual tour projects.

Method	Endpoint	Description
GET	`/v1/projects`	List all projects in the workspace
POST	`/v1/projects`	Create a new project
GET	`/v1/projects/{id}`	Get project details
PUT	`/v1/projects/{id}`	Update project settings
DELETE	`/v1/projects/{id}`	Delete a project
POST	`/v1/projects/{id}/duplicate`	Duplicate a project
GET	`/v1/projects/{id}/versions`	List version history
POST	`/v1/projects/{id}/versions/{vid}/restore`	Restore a version
POST	`/v1/projects/{id}/export`	Export as self-hosted package
GET	`/v1/projects/{id}/activity`	Get project activity log

Request

curl https://api.3syxty.com/v1/projects \
  -H "Authorization: Bearer sk_live_..." \
  -X POST \
  -d '{"name": "Beach Resort Tour", "description": "Virtual walkthrough of the resort"}'

Response

{
  "success": true,
  "data": {
    "id": "proj_nR4kW8vP",
    "name": "Beach Resort Tour",
    "description": "Virtual walkthrough of the resort",
    "scenes_count": 0,
    "status": "draft",
    "created_at": "2026-03-03T20:15:00Z"
  }
}

Scenes

Manage scenes (panoramas) within a project.

Method	Endpoint	Description
GET	`/v1/projects/{id}/scenes`	List all scenes in a project
POST	`/v1/projects/{id}/scenes`	Add a scene to a project
GET	`/v1/scenes/{id}`	Get scene details
PUT	`/v1/scenes/{id}`	Update scene properties
DELETE	`/v1/scenes/{id}`	Delete a scene
PUT	`/v1/projects/{id}/scenes/reorder`	Reorder scenes

Hotspots

Create and manage interactive hotspots within scenes.

Method	Endpoint	Description
GET	`/v1/scenes/{id}/hotspots`	List hotspots in a scene
POST	`/v1/scenes/{id}/hotspots`	Create a hotspot
GET	`/v1/hotspots/{id}`	Get hotspot details
PUT	`/v1/hotspots/{id}`	Update a hotspot
DELETE	`/v1/hotspots/{id}`	Delete a hotspot
POST	`/v1/scenes/{id}/hotspots/reorder`	Reorder hotspots

Assets

Upload and manage media assets (images, video, audio, 3D models).

Method	Endpoint	Description
GET	`/v1/projects/{id}/assets`	List assets in a project
POST	`/v1/projects/{id}/assets`	Upload an asset (multipart/form-data)
GET	`/v1/assets/{id}`	Get asset metadata
DELETE	`/v1/assets/{id}`	Delete an asset

Publishing

Publish, unpublish, and check the status of tour deployments.

Method	Endpoint	Description
POST	`/v1/projects/{id}/publish`	Publish a tour
GET	`/v1/projects/{id}/publish/status`	Check publish status
POST	`/v1/projects/{id}/unpublish`	Unpublish a tour
GET	`/v1/projects/{id}/embed-codes`	Get embed codes and URLs

Analytics

Retrieve engagement analytics, heatmaps, and export data.

Method	Endpoint	Description
GET	`/v1/projects/{id}/analytics`	Get analytics summary
GET	`/v1/projects/{id}/analytics/heatmaps`	Get heatmap data
GET	`/v1/projects/{id}/analytics/export`	Export analytics as CSV/JSON

AI Services

Access AI-powered tools: scene analysis, generative fill, virtual staging, narration, and more.

Method	Endpoint	Description
POST	`/v1/ai/analyze-scene/{scene_id}`	Analyse a scene with computer vision
POST	`/v1/ai/auto-connect/{project_id}`	Auto-connect scenes based on spatial analysis
POST	`/v1/ai/narration/{scene_id}`	Generate voiceover narration
POST	`/v1/ai/generative-fill`	AI-powered panoramic inpainting
POST	`/v1/ai/virtual-stage/{scene_id}`	Virtual staging with AI furniture
POST	`/v1/ai/remove-tripod/{scene_id}`	Remove tripod from nadir
POST	`/v1/ai/dollhouse/{project_id}`	Generate 3D dollhouse model
POST	`/v1/ai/quality-check/{project_id}`	AI quality audit
POST	`/v1/ai/translate/{project_id}`	AI-translate tour content
POST	`/v1/ai/chat`	Conversational AI assistant

Webhooks

Method	Endpoint	Description
GET	`/v1/webhooks`	List registered webhooks
POST	`/v1/webhooks`	Register a new webhook
PUT	`/v1/webhooks/{id}`	Update a webhook
DELETE	`/v1/webhooks/{id}`	Delete a webhook
GET	`/v1/webhooks/{id}/deliveries`	View delivery history
POST	`/v1/webhooks/{id}/test`	Send a test event

Leads

Manage lead submissions captured from tour contact forms.

Method	Endpoint	Description
GET	`/v1/leads`	List all leads
PUT	`/v1/leads/{id}`	Update lead status/notes
GET	`/v1/leads/export`	Export leads as CSV

Templates & Marketplace

Browse, create, and use tour templates from the marketplace.

Method	Endpoint	Description
GET	`/v1/templates`	List available templates
GET	`/v1/templates/{id}`	Get template details
POST	`/v1/templates`	Publish a template to the marketplace
POST	`/v1/templates/{id}/use`	Create a project from a template

Integrations

Connect third-party services: CRM, MLS, analytics, and more.

Method	Endpoint	Description
GET	`/v1/integrations`	List configured integrations
POST	`/v1/integrations`	Create an integration
PUT	`/v1/integrations/{id}`	Update an integration
DELETE	`/v1/integrations/{id}`	Remove an integration
POST	`/v1/integrations/{id}/test`	Test an integration connection

Quizzes & E-Learning

Manage quizzes, questions, and learner progress.

Method	Endpoint	Description
GET	`/v1/projects/{id}/quizzes`	List quizzes in a project
POST	`/v1/projects/{id}/quizzes`	Create a quiz
PUT	`/v1/quizzes/{id}`	Update a quiz
DELETE	`/v1/quizzes/{id}`	Delete a quiz
GET	`/v1/quizzes/{id}/questions`	List questions in a quiz
POST	`/v1/quizzes/{id}/questions`	Add a question
GET	`/v1/projects/{id}/leaderboard`	Get leaderboard
GET	`/v1/projects/{id}/progress/{learner_id}`	Get learner progress
GET	`/v1/projects/{id}/scorm-export`	Export as SCORM package

Comments

Manage collaborative review comments on projects.

Method	Endpoint	Description
GET	`/v1/projects/{id}/comments`	List all comments
POST	`/v1/projects/{id}/comments`	Add a comment
GET	`/v1/comments/{type}/{entity_id}`	Get comments for a specific entity
POST	`/v1/comments/{id}/resolve`	Resolve a comment
DELETE	`/v1/comments/{id}`	Delete a comment

Search

Global search across projects, scenes, and assets.

Method	Endpoint	Description
GET	`/v1/search?q={query}`	Search across all resources

API Tokens

Manage API keys programmatically.

Method	Endpoint	Description
GET	`/v1/tokens`	List API tokens
POST	`/v1/tokens`	Create a new API token
DELETE	`/v1/tokens/{id}`	Revoke a token

Error Codes

The API uses standard HTTP status codes. Error responses include a machine-readable code field for programmatic handling.

HTTP Status	Error Code	Description
400	`VALIDATION_ERROR`	Request body or parameters failed validation
401	`UNAUTHORIZED`	Missing or invalid authentication token
403	`FORBIDDEN`	Authenticated but insufficient permissions
404	`RESOURCE_NOT_FOUND`	The requested resource does not exist
409	`CONFLICT`	Resource state conflict (e.g. duplicate name)
422	`UNPROCESSABLE_ENTITY`	Request understood but cannot be processed
429	`RATE_LIMIT_EXCEEDED`	Too many requests — slow down
500	`INTERNAL_ERROR`	Unexpected server error — contact support

API Versioning

The API is versioned via the URL path (/v1/). We follow semantic versioning principles:

→ Additive changes (new fields, new endpoints) are non-breaking and do not require a version bump
→ Breaking changes (removed fields, changed behaviour) result in a new version (/v2/)
→ Deprecated versions receive at least 12 months of support after a successor is released