Engineering

API Reference

Practical map of Urmate API families.

API Reference

This page is a working map of Urmate's API families. Use the route tree as the final source of truth, but this grouping explains where engineers should look first.

Dashboard And Account

APIPurpose
/api/auth/[...all]Better Auth route handler.
/api/settings/accountAccount-level settings.
/api/settings/profileProfile fields and avatar-related metadata.
/api/settings/preferencesUser preferences.
/api/dashboard/searchGlobal dashboard search.
/api/help/ticketsHelp center tickets.

Study

APIPurpose
/api/study/libraryLibrary overview.
/api/study/coursesStudent-visible courses.
/api/study/boardsBoards and learning organization.
/api/study/podcastsPodcasts and episode detail.
/api/study/instructorsPublic instructor directory and profiles.
/api/study/instructor/*Instructor application, profile, sessions, certificates, calendar, bookings, resources.
/api/study/organizationsOrganization membership and joining.
/api/study/notificationsStudy notification feed and summary.
/api/study/copilot/*Study copilot sessions and chat.
/api/study/admin/*Study admin controls.

Chat Workspace

APIPurpose
/api/chat/tasksAI task board and task workroom.
/api/chat/communityCommunity catalog, detail, marketplace, and installs.
/api/chat/channels/platformsSupported external messenger platforms.
/api/chat/channels/providersUser-connected channel providers.
/api/chat/channels/agentsChannel agents and behavior settings.
/api/chat/channels/threadsExternal conversation threads.
/api/chat/channels/webhooks/[platform]/[applicationId]Incoming Telegram, Discord, WhatsApp, Instagram, and similar channel webhooks.

XRouter

APIPurpose
/api/xrouter/v1/chat/completionsOpenAI-compatible chat endpoint.
/api/xrouter/v1/messagesAnthropic-compatible messages endpoint.
/api/xrouter/v1/modelsModel catalog.
/api/xrouter/v1/images/*Image generation/editing endpoints.
/api/xrouter/v1/videos/*Video generation endpoints.
/api/xrouter/v1/embeddingsEmbedding endpoint.
/api/xrouter/providersProvider configuration.
/api/xrouter/model-catalogInternal catalog aggregation.
/api/xrouter/cli-tools/*CLI integration settings and status.

Builders And Runtimes

See the builder, game builder, code tutor, and cloud infrastructure pages for feature-specific route details.

Copyright © 2026