PIpipeshub-ai
Knowledge Base

Move record to another location

Changed on

Move a file or folder record to a different location within the same knowledge base.

Set newParentId to a folder ID to move the record into that folder, or null (or an empty string) to move it to the knowledge base root. A folder moves with everything in it. Moving a record to where it already is answers 200 with the same body.

Required Permission: OWNER or WRITER. A READER gets 403; a caller with no role on the knowledge base gets 404 (Knowledge base not found).

Request: only newParentId is read; other body fields and any query parameter are ignored.

put/knowledgeBase/{kbId}/record/{recordId}/move

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/{kbId}/record/{recordId}/move
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:write

Path parameters

kbIdstring uuid required

Knowledge base UUID

recordIdstring required

Record identifier (file or folder). A record that is not in this knowledge base (unknown, or in another one) is answered 404.

Request body

newParentIdstring nullable required

Target folder ID, or null to move the record to the knowledge base root

Response

Record moved successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Record moved successfully"
}

Changes