Smart Search
BETA: This API resource is not finalized, and there could be breaking changes before its final release.
API for AI-powered course content search. NOTE: This feature has limited availability at present.
A SearchResult object looks like:
BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.
GET /api/v1/courses/:course_id/smartsearch
GET /api/v1/courses/:course_id/smartsearch
Scope: url:GET|/api/v1/courses/:course_id/smartsearch
Find course content using a meaning-based search
Request Parameters:
q
Required string
The search query
filter[]
string
Types of objects to search. By default, all supported types are searched. Supported types include pages
, assignments
, announcements
, and discussion_topics
.
Returns a list of SearchResult objects.
This documentation is generated directly from the Canvas LMS source code, available on Github.
Last updated