Guide

List user's guides

Returns a list of guides for the authenticated user.

Use query to check whether a guide already exists before creating one (creating a duplicate costs credits). Beware of two behaviours of this endpoint:

query and group are case-insensitive REGULAR EXPRESSIONS, not exact matches: special characters in the value are interpreted as regex syntax, and an invalid regex returns no result at all. (status is different: a known status is matched exactly, any other value falls back to a regex.) Always compare the returned query and source yourself, and fall back to an unfiltered paginated scan before concluding that nothing exists;
totalCount does NOT take query nor group into account (known limitation: both are applied as application-level regexes that the count query does not know, so it returns 0 as soon as either is used, alone or combined with status). Filtering on status alone does give a correct totalCount, since it is a real stored field. For an existence check, trust the guides actually returned; totalCount is only reliable for paginating a listing filtered by status alone, or not filtered at all.

An empty result is returned as a 404 with success: false and error: "No guides returned", not as an empty list.

get/api/v1/guides

Request

Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
URL: https://app.serpmantics.com/api/v1/guides
Auth: HTTP bearer

Query parameters

Page number for pagination

Number of guides per page

querystring

Filter on the guide query. Case-insensitive partial match, interpreted as a regular expression (see the endpoint description).

groupstring

Filter on the guide group. Case-insensitive partial match, interpreted as a regular expression.

status'draft' | 'active' | 'review' | 'published' | 'archived'

Filter on the guide status. Exact match when the value is one of the known statuses, otherwise a case-insensitive regular expression.

Response

Successful response with guides

successboolean

Example response

{
  "guides": [
    {
      "shareState": "shared-read",
      "expired": true,
      "progressStatus": {
        "message": "Pas assez de sources exploitables : ChatGPT a cité trop peu de pages accessibles pour cette requête. Essayez une requête plus générale, ou la source Google. Vos crédits sont recrédités automatiquement.",
        "failureFacts": {
          "attempted": 22,
          "readable": 1,
          "unreadable": {
            "notAnalyzable": 14,
            "invalidContent": 5,
            "unreachable": 2
          }
        }
      },
      "corpusTopWindow": {
        "fallback": true,
        "maxPosition": 22,
        "documents": 3
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.