Skip to main content

Authentication

All Zvid API endpoints require authentication using an API key. This guide explains how to create, use, and manage your API keys securely.

Overview​

The Zvid API uses API keys for authentication. API keys are unique identifiers that allow you to access the API programmatically without needing to log in with your username and password.

Creating an API Key​

First API key to be used must be created through the Zvid Dashboard:

  1. Log in to your Zvid account
  2. Click the API Access box at the bottom right corner.
  3. Click Create API Key at the top right corner.
  4. Provide a descriptive name for your key (e.g., "Production Server", "Development", "Mobile App")
  5. Confirm by clicking Create API Key
  6. Copy and save the generated key immediately - you won't be able to see it again!
Important

The full API key is only shown once during creation. If you lose it, you'll need to create a new key.

Using API Keys​

Include your API key in the x-api-key header with every request:

cURL Example​

curl -X GET https://api.zvid.io/api/user/profile \
  -H "x-api-key: zvid_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"

JavaScript/Node.js Example​

const response = await fetch("https://api.zvid.io/api/user/profile", {
  headers: {
    "x-api-key":
      "zvid_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  },
});

const data = await response.json();
console.log(data);

API Key Format​

Zvid API keys follow this format:

zvid_<64-character-hexadecimal-string>
  • zvid_ - Prefix indicating this is a Zvid production key
  • 64 characters - Hexadecimal string (a-f, 0-9)

Example: zvid_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

Need Help?​

If you're having authentication issues:

  1. Verify your API key is correct
  2. Check that the x-api-key header is properly formatted
  3. Ensure your API key hasn't been revoked
  4. Contact support help@zvid.io if issues persist