Docs API reference Notes API reference
Notes Notes and bookmarks on lessons and videos, and their export.
Paths are relative to /api/v1 on your server.
Edit a bookmark Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · Bookmark 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeDelete a bookmark Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)
204 Done; no body. 401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeGET /items/{id} /bookmarks# Bookmarks on an item The caller’s own, by the moment. within=true adds those on everything under the item — a book’s parts, a course’s lessons — each naming its own itemId.
Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)withinquery
200 Success. application/json · object 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopePOST /items/{id} /bookmarks# Add a bookmark Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
201 Success. application/json · Bookmark 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeNotes on an item Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)
200 Success. application/json · object 401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeAdd a note Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
201 Success. application/json · Note 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeEdit a note Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · Note 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeDelete a note Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)
204 Done; no body. 401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeExport my notes Markdown for one course, a zip of Markdown files for everything, or JSON.
Authorisation Bearer token or API key · Session cookie Parameter In Type Description scope required query "notes"formatquery "markdown" | "json"courseIdquery string (uuid)
200 Success. application/octet-stream · 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelopeSearch my notes Authorisation Bearer token or API key · Session cookie Parameter In Type Description q required query stringlimitquery integer
200 Success. application/json · object 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks library:view, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelopeNo endpoint here matches. Try another word, or look in another area .