Semantic Search

Clear all search history

Changed on

Permanently delete every persisted search row owned by, or shared with, the authenticated user, along with the citation rows those searches reference. The action cannot be undone. Searches other users shared with the caller are deleted for their owners too, even when the caller only has read access.

Scoped to the caller's org and limited to rows where isArchived: false. The optional shared, startDate and endDate query filters narrow what is deleted; search is validated but has no effect. If nothing matches (including the case where every row is already archived), the endpoint returns 404 rather than a successful no-op.

delete/search

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/search
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: semantic:delete

Query parameters

searchstring

Validated, then dropped: a stored search has no title to match, so it never narrows the deletion. More than 1000 characters, or HTML markup, is refused with 400.

shared'true' | 'false' | '1' | '0'

Restrict the deletion to rows with this isShared value. 'true' / '1' and 'false' / '0', case-insensitive; anything else is refused with 400.

startDatestring

ISO 8601 date or date-time lower bound for createdAt. A value JavaScript's Date cannot parse is refused with 400.

endDatestring

ISO 8601 date or date-time upper bound for createdAt. A value JavaScript's Date cannot parse is refused with 400.

Response

Search history deleted successfully.

messagestring required

Changes

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2} to the query request parameter endDate

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2} to the query request parameter startDate

    • warning

      for the query request parameter search, the maxLength was set to 1000

    • info

      added the new enum value 0 to the query request parameter shared

    • info

      added the new enum value 1 to the query request parameter shared

    • info

      for the query request parameter endDate, the format was generalized from date-time to no format

    • info

      for the query request parameter startDate, the format was generalized from date-time to no format

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status