Built LMS Help Center

GET Search course content

Hybrid semantic plus keyword search over course content blocks in the authenticated organization. A row is returned when either engine matches it - a keyword match on the query terms, or a semantic similarity above the relevance floor - and rows are ordered by Reciprocal Rank Fusion of the two engines. The score field is the cosine similarity to the query in [-1, 1], or null when the row was matched by keywords only, and it is not monotonically decreasing because the ordering key is the fusion score rather than the similarity. Content belonging to unpublished or archived courses is never returned. There is no pagination - the response is a single window capped at limit, and meta.total is the number of rows in that window, not a count of matching content in the corpus.

GET
/content/search

Hybrid semantic plus keyword search over course content blocks in the authenticated organization. A row is returned when either engine matches it - a keyword match on the query terms, or a semantic similarity above the relevance floor - and rows are ordered by Reciprocal Rank Fusion of the two engines. The score field is the cosine similarity to the query in [-1, 1], or null when the row was matched by keywords only, and it is not monotonically decreasing because the ordering key is the fusion score rather than the similarity. Content belonging to unpublished or archived courses is never returned. There is no pagination - the response is a single window capped at limit, and meta.total is the number of rows in that window, not a count of matching content in the corpus.

Authorization

BearerAuth
AuthorizationBearer <token>

Send API keys and access tokens as Authorization: Bearer .

In: header

Query Parameters

q*string

Free-text search query

Length1 <= length <= 30000
limit?integer

Maximum number of results to return (1-50). An empty value is treated as absent and the default applies.

Range1 <= value <= 50
Default10

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/content/search?q=string"
{  "data": {    "data": null,    "meta": {      "organization_id": "{organization_id}",      "total": 0,      "total_count": 0,      "limit": 0,      "offset": 0,      "has_more": true,      "requested_at": "2019-08-24T14:15:22Z"    }  },  "meta": {    "organization_id": "{organization_id}",    "total": 0,    "total_count": 0,    "limit": 0,    "offset": 0,    "has_more": true,    "requested_at": "2019-08-24T14:15:22Z"  }}