Getting Started

Everything you need to set up and start integrating with the VSee Clinic API.

Environments

VSee provides two separate environments. Each has its own domain, credentials, and data. Tokens from one environment will not work in the other.

Staging (Test)
Clinic URL
https://yourcode.vseepreview.com
API Base URL
https://api.vseepreview.com/api_v3
Production (Live)
Clinic URL
https://yourcode.vsee.me
API Base URL
https://api.vsee.me/api_v3
Important: Staging and production are completely separate. Your staging Account Code, API tokens, and API Key/Secret will not work in production, and vice versa. Always verify you're using the correct base URL and credentials for your target environment.

Sign Up for a Developer Account

To start building with the VSee Clinic API, you'll need a developer account. This gives you a staging clinic with API credentials to develop and test your integration.

Configure Your Credentials

Enter your API credentials below. They'll be saved in your browser and auto-populated across all use cases and the Try It feature, so you don't have to re-enter them for every request.

No credentials configured
Clinic URL
Your clinic's base URL for redirects
X-AccountCode
X-ApiKey
X-ApiSecret
X-ApiToken
Clinic Admin API Token from dashboard
Admin Token
Room Slug
Waiting room slug used in redirect URLs
Room Code
Waiting room code used in API requests
Provider ID
ID of the provider handling visits (from Provider SSO data.id)
Credentials are stored in your browser's sessionStorage (cleared when you close the tab) and never sent to our servers.

Onboarding Checklist

1
Get a Developer Account

Sign up for a developer account to get a staging clinic with API access. See the sign up instructions for a detailed walkthrough.

2
Receive Staging Clinic

You'll be assigned a staging clinic at yourcode.vseepreview.com.

3
Obtain API Credentials

Get your Account Code, API Key/Secret (for SSO), and Clinic Admin API Token from the staging admin dashboard.

4
Build and Test in Staging

Develop your integration against the staging API. All test data stays in the staging environment.

5
Request Production Access

When your integration is tested and ready, request production credentials for your live clinic.

Quick Start Example

Here's a simple test to verify your credentials. This calls the Settings API, which only requires an Account Code:

curl -X GET https://api.vseepreview.com/api_v3/settings \
  -H "X-AccountCode: YOUR_ACCOUNT_CODE"

If you get a JSON response with clinic settings, your Account Code is valid and you're connected to the right environment.

Browse & Download OpenAPI Specs

All 16 APIs are published as OpenAPI 3.0 specifications. Browse the full list and download any spec as raw JSON — ready to import into Postman, Swagger, or AI tools.

Browse OpenAPI Specs

CORS & Browser Requests

The VSee API does not support CORS for direct browser-to-API calls. You cannot call the API directly from frontend JavaScript running in a browser.

If you're building a web application, all API calls must be routed through your backend server. Your server-side code makes the API call, then returns the result to your frontend.

Browser
Your Web App
Server
Your Backend
API
VSee API

Common Mistakes

I'm getting a 403 "Bad Request" error

This usually means you're using the wrong token type for this endpoint. For admin operations (creating rooms, managing webhooks, etc.), you need the Clinic Admin API Token from the dashboard — not a user session token from login/SSO.

I'm getting "Unauthorized Access"

Your token may be expired, invalid, or from the wrong environment. Check that: (1) your token hasn't expired, (2) you're using staging tokens with the staging URL and production tokens with the production URL, and (3) your Account Code matches the environment.

I'm getting a CORS error in the browser

The VSee API does not support CORS. You must route all API calls through your backend server. Direct browser-to-API calls will always fail with a CORS error.

What's the difference between vseepreview.com and vsee.me?

vseepreview.com is the staging (test) environment and vsee.me is production (live). They're completely separate — different data, different credentials. Always develop and test in staging first.

Why do I have two different tokens?

Your clinic has a Clinic Admin API Token (for server-side admin operations) and user session tokens (returned when users log in). They serve different purposes and have different permissions. See the Authentication Guide for details.