La recherche trouve les dossiers (par leur nom) et les contenus (par leur titre et leur description) du compte, partout dans sa bibliothèque : recherche par sous-chaîne, casse et accents ignorés, les dossiers d’abord. Elle n’est pas paginée : limit borne le nombre de résultats.
L’objet SearchResults
Résultats de recherche (bornés par limit, sans curseur).
| Champ | Type | Description |
|---|---|---|
results | SearchResult[] | Les dossiers d’abord, puis les contenus ; limit éléments au plus. |
{
"results": [
{
"type": "content",
"id": "3f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87",
"title": "Photosynthesis",
"description": null,
"folderId": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60"
}
]
}L’objet SearchResult
Un résultat de recherche.
| Champ | Type | Description |
|---|---|---|
type | "content" | "folder" | Nature du résultat : content ou folder. |
id | string (uuid) | Identifiant du contenu ou du dossier. |
title | string | Titre du contenu, ou nom du dossier. |
description | string | null | Description, ou null. |
folderId | string | null | Dossier qui range le résultat (le parent, pour un dossier), ou null. |
Rechercher dans la bibliothèque
/v1/searchScope search:readTrouve les contenus (titre, description) et les dossiers (nom) du compte au nom duquel la clé d’API agit, partout dans sa bibliothèque. Recherche par sous-chaîne, casse et accents ignorés ; les dossiers d’abord, puis les contenus.
Paramètres
| Champ | Où | Type | Description |
|---|---|---|---|
qobligatoire | requête | string2 à 200 caractères | Texte recherché, de 2 à 200 caractères (casse et accents ignorés). |
limit | requête | integerde 1 à 100 · défaut 20 | Nombre maximal de résultats, de 1 à 100 (20 par défaut). |
Réponse 200
Les résultats — Un objet SearchResults
Erreurs
| HTTP | Signification |
|---|---|
400 | validation_error ou invalid_cursor |
401 | invalid_api_key ou revoked_api_key |
403 | insufficient_scope, account_suspended, live_not_enabled ou forbidden |
406 | not_acceptable — l’en-tête Accept exclut application/json |
429 | rate_limited ou test_quota_exceeded — voyez les en-têtes Retry-After et RateLimit-* |
500 | internal_error |
503 | unavailable — voyez l’en-tête Retry-After |
curl "https://api.memojin.com/v1/search?q=photosynth&limit=20" \
-H "Authorization: Bearer $MEMOJIN_API_KEY"{
"results": [
{
"type": "content",
"id": "3f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87",
"title": "Photosynthesis",
"description": null,
"folderId": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60"
}
]
}