Skip to content

Quick Start Guide

Welcome to the Teleport Developer Documentation!

This guide walks you through getting started with the Teleport API — from setting up your account and obtaining your API credentials to making your first authenticated request and uploading captures for processing through our 3D reconstruction pipeline.

You need a Developer Plan to use the Teleport API

To access the Teleport API, you’ll need an active Developer Plan. If you don’t have one yet, visit our pricing page to learn how to upgrade your account.

1. Get Your API Key#

Before you can start using the API, you’ll need to obtain your Teleport API key.

  1. Log in to your account and open the Developer Dashboard.
  2. Click Request API Key if you haven’t already done so. Your key will be issued within 24 hours.
  3. Once available, copy your client_id and client_secret values and store them securely — you’ll need them for authentication.

⚠️ Keep your client_secret safe. Treat it as you would treat your account’s password.

2. Base URL#

All Teleport API endpoints are available under the following base URL:

https://teleport.varjo.com/api/v1/

For example:

GET https://teleport.varjo.com/api/v1/captures

3. Authentication#

All API requests must be authenticated using an access token. To obtain one, send a POST request to the Teleport authentication service:

curl -X POST "https://signin.teleport.varjo.com/oauth2/token" \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": CLIENT_ID,
    "client_secret": CLIENT_SECRET,
    "scope": "openid profile email"
  }'

Example response:

{
  "access_token": "AUTH_TOKEN",
  "expires_in": 3600,
  "token_type": "bearer"
}

Use the returned AUTH_TOKEN as your authorization header for subsequent API requests:

⚠️ The expires_in field in the response tells you that the token is valid for an hour (3600 seconds). If you encounter a 401 Unauthorized in the authenticated requests, you should request a new one like listed above.

4. Example Request#

Here’s a simple example using curl to retrieve the list of your captures:

curl -X GET "https://teleport.varjo.com/api/v1/captures" \
  -H "Authorization: Bearer AUTH_TOKEN"

If the authentication fails, you’ll receive a 401 Unauthorized response.

If successful, the response will contain your uploaded captures — or an empty array [] if you haven’t uploaded any yet.

Example response:

[
  {
    "eid": "...",
    "sid": "...",
    "name": "My Capture",
    "created": "2025-10-06T18:55:42.733421",
    "uploaded": "2025-10-06T18:55:44.364236",
    "state": "READY",
    "error_reason": null,
    "state_description": null,
    "error_reason_slug": null,
    "preview_urls": {
      "432x576": "...",
      "897x1196": "..."
    },
    "preview_url": null,
    "viewer_url": "https://teleport.varjo.com/captures/...",
    "share_url": "https://teleport.varjo.com/captures/...",
    "share_link": "https://teleport.varjo.com/share/...",
    "gif_url": "...",
    "video_url": "...",
    "share_video_url": "...",
    "is_public": false
  }
]

5. Next Steps#

You’re now ready to start using the Teleport API!

Check out the following guides to learn more:

💡 Tip: Keep your API key in environment variables and never hardcode it into client-side code or version control.

Need more help?

Visit our Help Center or send us an email at teleport@varjo.com.