v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-02527773.5 KB
Global Search

Perform a unified semantic search across entity types

Searches across multiple entity types (exercises, lectures, lecture units, exams, FAQs, channels, courses, posts, answer posts) with a consistent response format. When courseId is not specified, the search is performed globally across all courses the authenticated user has access to. Per-type access rules are enforced server-side via compound Weaviate filters.

get/api/search

Query parameters

qstring required

Search query; can be empty to retrieve recent items

typesstring

Comma-separated entity type filter (exercise, lecture, lecture_unit, exam, faq, channel, course, post, answer_post) or 'all'; default 'all'

courseIdinteger

Course ID to restrict the search to a single course

limitinteger

Maximum number of results (1–25, default 10)

Response

Search results matching the query

idstring

Unique identifier of the entity

typestring

Entity type, e.g. 'exercise', 'lecture', 'exam'

titlestring

Display title of the entity

descriptionstring

Short description or body text excerpt

badgestring

Human-readable badge label, e.g. 'Programming', 'Quiz', 'Lecture'

metadataobject

Additional type-specific metadata such as courseId, dueDate, or points