Skip to main content

Access keys

An access key works like a password for one tool: a study-sheet sync, a script, a phone shortcut. The tool sends it with each request to the API, and the key reaches only the parts of your library you ticked when you made it. Keys look like vcp_pat_ followed by a long random string. Keep a key out of anything you share.

Making a key​

  1. On the website, open Account → Other apps and press Make a key.
  2. Give it a Name, so you know which tool uses it, like "Study sheet sync".
  3. Tick what it can reach. Each part has three boxes: Read, Change and Delete. Tick at least one part to read.
  4. Choose when it Stops working after: 30, 90 or 365 days, or Never. Never is allowed only for a key that only reads; a key that can change or delete always has an end date.
  5. Press Make key, then copy it. This is the one time it is shown without signing in again.

Making a key needs a sign-in from the last ten minutes, and your two-step code when two-step sign-in is on. We email you that a key was made. The email never contains the key.

What each tick reaches​

A tick becomes a permission on the key. The API answers 403 scope_required, naming the permission, when a key asks for something it wasn't given.

Part on the websiteReadChangeDeleteWhat it covers in the API
Bookmarksbookmarks:readbookmarks:writebookmarks:deletebookmarks
Notesnotes:readnotes:writenotes:deletenotes
Collectionscollections:readcollections:writecollections:deletecollections, collection_videos
Flashcardsflashcards:readflashcards:writeflashcards:deleteflashcards
Learning pathspaths:readpaths:writepaths:deletelearning_paths, path_videos
Watch historyhistory:readhistory:deletewatch_history
Watch laterlater:readlater:writelater:deletewatch_later
Transcriptstranscripts:readtranscripts:writetranscripts:deletetranscripts, transcript_texts
Screenshotsscreenshots:readscreenshots
Settings and shortcutssettings:readsettings:writesettings
Devicesdevices:readdevices:writedevices:deletedevices
Watch partiesparties:readwatch_parties, party_members
Community site fixesfixes:readsite_fixes
Feature requestsrequests:readfeature_requests, request_votes

An empty box is a box the website doesn't offer: watch history has no change, screenshots and the shared parts are read only, and settings can't be deleted. Every key can also read your plan and today's use (account:read, the account part of the API) without a tick.

Showing a key again​

Press Show again on the key. We show it only within ten minutes of signing in, so a browser left open can't hand it out, and with your two-step code when two-step is on. A remembered browser still asks for the code here. The key stays on screen for a short while; close it when you've copied it.

Replacing a key​

Press Replace when a key may have leaked, or when you want a fresh one. You get a new key with the same name and the same parts. The key it replaced keeps working for 24 hours so you can swap it over, then it stops.

Removing a key​

Press Remove, then press it again to confirm. The next request with that key gets "not allowed" (401 invalid_token). Nothing else changes: your library, your other keys and your assistants stay as they are.

Checking what a key can do​

GET /token answers with the key's kind and its permissions, sorted:

curl https://gjajgvsjhdbtrpvfiuwl.supabase.co/functions/v1/api/v1/token \
-H "Authorization: Bearer $VCP_KEY"
{
"data": {
"kind": "pat",
"user_id": "6a1f0c52-3b7d-4e8a-9f21-0c4d5e6b7a89",
"client_id": null,
"scopes": ["account:read", "bookmarks:read", "notes:read", "notes:write"]
}
}

Other apps also shows when each key was made, when it was last used and when it stops working.

How many you can have​

Free holds 5 keys, Pro 25 and Team 50 for each member. A removed key doesn't count. When you're at the limit, remove one, or move to a plan with more on Plans.