Search finds the folders (by name) and contents (by title and description) of the account, anywhere in its library: substring search, case and accents ignored, folders first. It is not paginated: limit caps the number of results.
The SearchResults object
Search results (bounded by limit, without a cursor).
| Field | Type | Description |
|---|---|---|
results | SearchResult[] | Folders first, then contents; limit items at most. |
SearchResults
{
"results": [
{
"type": "content",
"id": "3f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87",
"title": "Photosynthesis",
"description": null,
"folderId": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60"
}
]
}The SearchResult object
A search result.
| Field | Type | Description |
|---|---|---|
type | "content" | "folder" | Nature of the result: content or folder. |
id | string (uuid) | Identifier of the content or folder. |
title | string | Title of the content, or name of the folder. |
description | string | null | Description, or null. |
folderId | string | null | Folder holding the result (the parent, for a folder), or null. |
Search the library
/v1/searchScope search:readFinds contents (title, description) and folders (name) of the account the API key acts for, anywhere in its library. Substring match, case and accents ignored; folders first, then contents.
Parameters
| Field | In | Type | Description |
|---|---|---|---|
qrequired | query | string2 to 200 characters | Searched text, 2 to 200 characters (case and accents ignored). |
limit | query | integerfrom 1 to 100 · default 20 | Results at most, 1 to 100 (default 20). |
Response 200
The results — A SearchResults object
Errors
| HTTP | Meaning |
|---|---|
400 | validation_error or invalid_cursor |
401 | invalid_api_key or revoked_api_key |
403 | insufficient_scope, account_suspended, live_not_enabled or forbidden |
406 | not_acceptable — the Accept header excludes application/json |
429 | rate_limited or test_quota_exceeded — see the Retry-After and RateLimit-* headers |
500 | internal_error |
503 | unavailable — see the Retry-After header |
Request
curl "https://api.memojin.com/v1/search?q=photosynth&limit=20" \
-H "Authorization: Bearer $MEMOJIN_API_KEY"Response 200
{
"results": [
{
"type": "content",
"id": "3f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87",
"title": "Photosynthesis",
"description": null,
"folderId": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60"
}
]
}