AI Index
OghmaNotes product and agent info
A compact factsheet for students, search engines, AI assistants, and agents that need Markdown resources or documented endpoints.
Short Answer
OghmaNotes is a Canvas-connected study workspace for university students. It brings supported course material and deadlines into the same workspace as notes, cited answers, flashcards, and planning, reducing repeated upload and setup.
Core Facts
- OghmaNotes is a Canvas-connected study workspace for university students.
- It brings supported course structure, files, assignments, and deadlines into the same workspace as notes, cited answers, flashcards, and planning.
- Canvas access depends on the institution, account permissions, and available APIs; imports and indexing may take time.
- OghmaNotes is an independent beta product built by students at University of Galway. It is not an official university or Canvas service.
Markdown Access
- Request this page as Markdown with
Accept: text/markdownor /info?format=md. - Use /info.md for the compact Markdown factsheet.
- Use /ai.md or /llms-full.txt for the full profile.
Resource Comparison
| URL | Format | Best use |
|---|---|---|
| /info | HTML or Markdown by negotiation | Compact product overview for humans, AI assistants, and evaluators. |
| /info.md | text/markdown | Compact Markdown factsheet with the core description, CTAs, and agent links. |
| /ai | HTML or Markdown by negotiation | Canonical human-readable AI information page. |
| /ai.md | text/markdown | Canonical full Markdown profile with facts, CTAs, FAQ, and action guidance. |
| /llms.txt | text/plain | Compact LLM index for quick retrieval and routing. |
| /llms-full.txt | text/plain | Full text profile for crawlers that prefer a single plain-text document. |
| /agents.md | text/markdown | Full agent guide with safe action boundaries and documented API routes. |
| /agent-api.json | application/json | OpenAPI-style endpoint guide for agents that can use structured API docs. |
| /openapi.json | application/json | Standard OpenAPI alias for tooling that expects a conventional API description URL. |
| /agent-sitemap.xml | application/xml | Machine-readable sitemap for the LLM and agent resources. |
| /faq.md | text/markdown | FAQ-only Markdown page for common product questions. |
| /pricing.md | text/markdown | Pricing-only Markdown page for plan and launch-pricing questions. |
| /auth.md | text/markdown | Agent registration instructions for new OghmaNotes users. It does not grant agent access to private APIs. |
Endpoint Quickstart
The structured version is available at /agent-api.json and /openapi.json. Authenticated endpoints require the user's browser session.
| Method | Path | Auth | Use |
|---|---|---|---|
GET | /info | No | Compact overview. Send Accept: text/markdown or add ?format=md for Markdown. |
GET | /ai | No | Full AI profile. Send Accept: text/markdown or add ?format=md for Markdown. |
GET | /agent-api.json | No | Structured endpoint documentation for agents. |
GET | /openapi.json | No | Standard OpenAPI alias for agent and API tooling. |
POST | /api/auth/register | No | Create an account. Prefer the browser-visible form for user-entered passwords. |
POST | /api/auth/login | No | Create a verified user session. Prefer an already authenticated browser context. |
GET/POST | /api/notes | Session | List or create the user's notes and folders. |
GET/PATCH/DELETE | /api/notes/{id} | Session | Read, update, or soft-delete one note owned by the user. |
GET | /api/search | Session | Search notes by keyword or semantic mode. |
GET | /api/global-search | Session | Search notes, chats, and quiz courses together. |
POST | /api/chat | Session | Ask cited study questions over the user's material. |
GET | /api/tree/children | Session | Fetch root or folder children for the notes tree. |
GET/POST/DELETE | /api/canvas/connect | Session | Read, create, or remove Canvas connection. Never collect Canvas tokens in chat. |
GET/POST | /api/canvas/sync | Session | Check whether Canvas sync is available or queue a sync job. |
GET | /api/canvas/status | Session | Read Canvas import job progress and recent file logs. |
GET/POST | /api/assignments | Session | List assignments or create a manual assignment. |
GET/POST | /api/calendar/token | Session | Read or rotate the user's private iCal subscription token. |
POST | /api/mcp/canvas | Internal bearer | Internal streamable HTTP MCP bridge for Canvas tools; not a public end-user MCP surface. |
Safe Action Boundaries
Agents should ask for explicit confirmation before registering accounts, submitting forms, connecting Canvas, importing private data, rotating calendar tokens, or asking questions over private study material.