PIpipeshub-ai
Semantic Search

Delete search by ID

Changed on

Permanently delete a single persisted search row, plus every citation row referenced by its citationIds. The caller must either own the row or have it shared with them: a user the search was shared with, even with read access only, deletes the owner's search for everyone.

Scoped to the caller's org and limited to rows where isArchived: false; an archived or already-deleted row is 404. The optional shared, startDate and endDate query filters must also match, otherwise 404; search is validated but has no effect.

delete/search/{searchId}

Request

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

Path parameters

searchIdstring objectId required

ObjectId of the persisted search row to delete.

Query parameters

searchstring

Validated, then dropped: a stored search has no title to match, so the row is deleted whatever this says. More than 1000 characters, or HTML markup, is refused with 400.

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

Additional isShared filter. 'true' / '1' and 'false' / '0', case-insensitive; anything else is refused with 400. The row is only deleted if it matches.

startDatestring

ISO 8601 date or date-time lower bound for createdAt. The row is only deleted if it was created on or after it. A value JavaScript's Date cannot parse is refused with 400.

endDatestring

ISO 8601 date or date-time upper bound for createdAt. The row is only deleted if it was created on or before it. A value JavaScript's Date cannot parse is refused with 400.

Response

Search deleted successfully.

messagestring required

Changes

  • dbb5e203b445Revision 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