Recherche

GET /v1/search : retrouvez les dossiers et les contenus d’un compte Memojin par leur nom, titre ou description, sans tenir compte des accents ni de la casse.

api.memojin.com/v1 · Contrat 1.0.0-beta.2 · Bêta

Sections · Recherche

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).

ChampTypeDescription
resultstoujours présentSearchResult[]Les dossiers d’abord, puis les contenus ; limit éléments au plus.
SearchResults
{
  "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.

ChampTypeDescription
typetoujours présent"content" | "folder"Nature du résultat : content ou folder.
idtoujours présentstring (uuid)Identifiant du contenu ou du dossier.
titletoujours présentstringTitre du contenu, ou nom du dossier.
descriptiontoujours présentstring | nullDescription, ou null.
folderIdtoujours présentstring | nullDossier qui range le résultat (le parent, pour un dossier), ou null.

Rechercher dans la bibliothèque

GET/v1/searchScope search:read

Trouve 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

ChampOùTypeDescription
qobligatoirerequêtestring2 à 200 caractèresTexte recherché, de 2 à 200 caractères (casse et accents ignorés).
limitfacultatifrequêteintegerde 1 à 100 · défaut 20Nombre maximal de résultats, de 1 à 100 (20 par défaut).

Réponse 200

Les résultats — Un objet SearchResults

Erreurs

HTTPSignification
400validation_error ou invalid_cursor
401invalid_api_key ou revoked_api_key
403insufficient_scope, account_suspended, live_not_enabled ou forbidden
406not_acceptable — l’en-tête Accept exclut application/json
429rate_limited ou test_quota_exceeded — voyez les en-têtes Retry-After et RateLimit-*
500internal_error
503unavailable — voyez l’en-tête Retry-After
Requête
curl "https://api.memojin.com/v1/search?q=photosynth&limit=20" \
  -H "Authorization: Bearer $MEMOJIN_API_KEY"
Réponse 200
{
  "results": [
    {
      "type": "content",
      "id": "3f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87",
      "title": "Photosynthesis",
      "description": null,
      "folderId": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60"
    }
  ]
}