V-44For the VocationalLMS Super Admin
A school's API keys, and reading reports with AI
See and revoke any school's API keys, and what the AI report reader needs from the platform.
How-to video V-44 · 0:59
Read the words of this video
Schools make their own API keys. To see them, click Hours, then School API keys, and choose the school. You see each key's name, its first characters, what it may do, and when it was last used. The key itself is never shown.
To stop a key, click Revoke, then click again. The school sees that VocationalLMS revoked it. A new key is made by the school's own School Admin.
Latest calls is the school's API log. Calls are limited to 120 a minute for each key, and the log is kept for 90 days.
The AI report reader uses the platform's own Anthropic key, the same as the course builder. Each school has its own switch, and agrees once to the notice. Under Import clock hours, Earlier imports shows each reading, with the model and about what it cost.
Open this in VocationalLMSHours > School API keys
What it is for
Schools make their own API keys (A-56). You can see any school's keys and its latest calls and revoke a key; you never see a key itself, because only a scrambled form is kept. The AI report reader (A-55) uses the platform's own Anthropic key and model, the same as the course builder.
Steps
See or revoke a school's keys
- Click Hours, then School API keys. Choose the School.
- The table lists the school's keys with their first characters, what they may do and when they were last used. Latest calls is the school's API log.
- To stop a key, click Revoke, then click again. The school sees that VocationalLMS revoked it. A new key is made by the school's own School Admin.
The AI report reader
- It works when the platform has an Anthropic key. Without one, a school's Import page says so and the column import still works.
- Each school has its own switch (on by default) and agrees once to the notice that files are sent to the AI service. The cost of each reading is shown to the school and kept with the import, under Earlier imports.
What happens next
API calls are limited to 120 a minute for each key and written to a log that is kept 90 days. A key works only under /api/v1/ and only for its own school. The reading step (vlms/aireader.py) is built to be used again for other imports, such as grades and student lists.
Common problems
| # | Problem | What to do |
|---|---|---|
| 1 | A school asks you to tell them their key. | Nobody can. They revoke it and make a new one. |
| 2 | A school's system is making far too many calls. | It is slowed down by itself at 120 a minute. If needed, revoke the key and tell the school. |
