PIpipeshub-ai
Semantic Search

Archive a search

Changed on

Archive a specific search result. Archived searches are hidden from the search history and from GET /search/{searchId}, and cannot be shared, unshared or deleted until they are unarchived.

The caller must own the search or have it shared with them: a user the search was shared with, even with read access only, can archive the owner's search for everyone.

patch/search/{searchId}/archive

Request

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

Path parameters

searchIdstring objectId required

Unique search identifier

Query parameters

searchstring

Validated, then dropped: a stored search has no title to match, so the search is archived 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 search is only archived if it matches, otherwise 404.

startDatestring

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

endDatestring

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

Response

Search archived successfully

idstring objectId required

Unique identifier of the archived search.

status'archived' required

Resulting status of the search after the operation.

archivedBystring objectId required

User ID of the user who archived the search.

archivedAtstring date-time required

Timestamp when the search was archived.

Example response

{
  "id": "65f1c0a4e2b9c4d8f3a1b2c3",
  "status": "archived",
  "archivedBy": "65f1c0a4e2b9c4d8f3a1b2c4",
  "archivedAt": "2026-05-10T12:34:56.789Z",
  "meta": {
    "requestId": "req_8f3a1b2c",
    "timestamp": "2026-05-10T12:34:56.789Z",
    "duration": 42
  }
}

Changes

  • dbb5e203b445Revision changes
    • info

      added the new optional query request parameter endDate

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter shared

    • info

      added the new optional query request parameter startDate

    • 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