How do I authenticate with the vitelnk API?

Generate an API key in Settings → API Keys, then send it as an Authorization: Bearer header on every request. The plaintext key is shown once at creation — store it somewhere safe, vitelnk only ever stores its prefix afterward.

What can I do with the API today?

Create and deactivate one-time-view share links, read and update a video's call-to-action (including adding or removing secondary links), and read a share link's analytics or the messages left on it.

Is the API available on my plan?

The API is available on Professional, Team, Lifetime, and Credits plans — the same plans that unlock one-time-view links. A key stops working immediately if your plan no longer qualifies.

Is there a rate limit?

Yes. Creating share links is limited per API key; all other endpoints share the same 60-requests-per-minute limit as the rest of vitelnk's API.

vitelnk API — Create Share Links, Manage CTAs & Read Analytics

Get an API key

1

Go to Settings → API Keys.

2

Click Generate new key and give it a name (e.g. "CRM integration").

3

Copy the plaintext key shown — it starts with vl_live_ and is shown exactly once.

4

Send it as an Authorization: Bearer <key> header on every request below.

💡 A key belongs to you personally, or to a workspace if you generate it while in a workspace context. A workspace-scoped key can only reach that workspace's videos.

Create a one-time-view share link

Generate a share link for a video that deactivates after its first view — useful for a form on your own site that hands each visitor a personal link.

JavaScript

const response = await fetch('https://vitelnk.com/api/v1/links', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer vl_live_your_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    videoId: 'your-video-slug',
    recipientName: 'Jane Smith',
    recipientEmail: '[email protected]',
  }),
});

const link = await response.json();
console.log(link.url);

Python

import requests

response = requests.post(
    'https://vitelnk.com/api/v1/links',
    headers={'Authorization': 'Bearer vl_live_your_key_here'},
    json={
        'videoId': 'your-video-slug',
        'recipientName': 'Jane Smith',
        'recipientEmail': '[email protected]',
    },
)

link = response.json()
print(link['url'])

PHP

<?php
$response = \Illuminate\Support\Facades\Http::withToken('vl_live_your_key_here')
    ->post('https://vitelnk.com/api/v1/links', [
        'videoId' => 'your-video-slug',
        'recipientName' => 'Jane Smith',
        'recipientEmail' => '[email protected]',
    ]);

$link = $response->json();
echo $link['url'];

Deactivate a link when it's no longer needed: DELETE /api/v1/links/{id}. Limited to a small number of link creations per hour per key.

Endpoint reference

Setting	What it does
POST /api/v1/links	Create a one-time-view share link for a video.
DELETE /api/v1/links/{id}	Deactivate a share link created via the API.
GET /api/v1/videos/{videoId}/cta	Read a video's current primary CTA and its secondary/social links.
PUT /api/v1/videos/{videoId}/cta	Update the primary CTA — button text, link, colour, or a Cal.com/Calendly calendar embed.
POST /api/v1/videos/{videoId}/cta/links	Add a secondary or social link below the video.
PATCH /api/v1/videos/{videoId}/cta/links/{linkId}	Update one secondary/social link.
DELETE /api/v1/videos/{videoId}/cta/links/{linkId}	Remove one secondary/social link.
GET /api/v1/videos/{videoId}/shares/{shareId}/analytics	Views, plays, completions, and CTA clicks for one share link.
GET /api/v1/videos/{videoId}/shares/{shareId}/messages	Viewer messages left on one share link, paginated.

{videoId} is the video's slug (visible in its share URL), not a numeric ID. {shareId} and {linkId} are the numeric IDs vitelnk assigns to that share link or CTA link.

Update a CTA to a Cal.com booking calendar

JSON

PUT /api/v1/videos/your-video-slug/cta

{
  "embedCalendar": true,
  "calendarProvider": "calcom",
  "calendarBookingUrl": "your-team/discovery-call"
}

A Cal.com booking link is the bare username/event-slug — no https:// or cal.com/ prefix. A Calendly link is the full URL, e.g. https://calendly.com/you/30min. Either format mistake is rejected with a 422 and an explanation of the expected shape, rather than silently saving a broken embed.

Read a share link's analytics

JSON

GET /api/v1/videos/your-video-slug/shares/482/analytics

{
  "analytics": {
    "share_id": 482,
    "name": "Prospect Link — Acme",
    "token": "abc123xyz",
    "views": 14,
    "plays": 11,
    "completions": 6,
    "completionRate": 54.5,
    "primaryCtaClicks": 3,
    "avgWatchProgress": 78
  }
}

Errors

Setting	What it does
401	Missing, invalid, revoked, or expired API key.
403	Your plan no longer includes API access, or a Cal.com/Calendly CTA update needs a paid plan.
404	The video or share link doesn't exist, or your key can't access it — vitelnk never distinguishes the two, so a key can't be used to probe for videos it doesn't own.
422	A required field is missing, or a Cal.com/Calendly booking link is in the wrong format for that provider.
429	Rate limit exceeded — slow down and retry after a moment.

API

Frequently asked questions