Get started

Authentication

Every request carries an API key as a bearer token. A key belongs to one organization and one environment.

Send the key

Put the key in the Authorization header. Keys are secrets: keep them on your server, never in a browser or a mobile app.

Check a key with GET /v1/account. It returns the organization and environment the key belongs to.

Test and Live

Environment	Key	What it does
Test	`vi_test_…`	Build and prove an integration. Nothing reaches a real member or customer.
Live	`vi_live_…`	Creates real Video Intros for real people. Not yet available.

The two environments are separate. A test key cannot read or create anything in Live, and a live key cannot touch Test. An integration is built and proven in Test before it is allowed to reach customers.

When a key is refused

Status	Code	Why
401	`unauthorized`	The API key is missing, malformed or revoked.
403	`environment_not_enabled`	A live key was used before live access is enabled for the organization.

Check a key

curl https://api.videointros.com/v1/account \
  -H "Authorization: Bearer $VIDEO_INTROS_API_KEY"

const response = await fetch("https://api.videointros.com/v1/account", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VIDEO_INTROS_API_KEY}`,
  },
});
const result = await response.json();

import os, requests

response = requests.get(
    "https://api.videointros.com/v1/account",
    headers={
        "Authorization": f"Bearer {os.environ['VIDEO_INTROS_API_KEY']}",
    },
)
result = response.json()

Response · 200

{
  "id": "org_71c0d2",
  "object": "account",
  "name": "Your Company",
  "industry": "exterior_remodeling",
  "environment": "test",
  "timezone": "America/New_York"
}