Move uploaded directory

Interface Description

Rename or move one uploaded directory with all files and subdirectories below it.

Endpoint

Field	Value
Method	PATCH
Path	/openapi/v2/knowledge-bases/{knowledgeBaseId}/source-directories/{directoryId}
Operation ID	moveSourceDirectory
Authentication	Bearer OpenAPI key

Parameters

Name	Location	Required	Type	Example	Description
knowledgeBaseId	path	Yes	string	knowledge-base-11111111-1111-4111-8111-111111111111	Knowledge-base identifier returned by knowledge-base APIs.
directoryId	path	Yes	string	directory-11111111-1111-4111-8111-111111111111	Uploaded-directory identifier returned by directory or tree APIs.
Idempotency-Key	header	Yes	string	mutation-2026-07-10-001	Client-generated key for safely retrying the same request. Reuse the same value for retries so duplicate work is not created.
If-Match	header	Yes	string	"1"	Current resourceRevision returned by the API. If the resource changed after it was read, the request returns a conflict instead of overwriting the newer change.

Request Body

application/json

Field	Required	Type	Example	Description
relativePath	Yes	string	handbook/archive	Target directory path inside the knowledge base. Its parent directory must already exist, except when moving the directory to the root.

Request Example

curl -X PATCH "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/source-directories/directory-11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer <openapi-key>" \
  -H "Idempotency-Key: mutation-2026-07-10-001" \
  -H "If-Match: \"1\"" \
  -H "Content-Type: application/json" \
  --data '{
  "relativePath": "handbook/archive"
}'

Successful Responses

202

Directory move or rename request accepted for background processing.

Field	Required	Type	Description
operation	Yes	object	File or directory change record returned by the request.

Success Response Example

{
  "operation": {
    "operationId": "directory-move-22222222-2222-4222-8222-222222222222",
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "kind": "source_directory_move",
    "state": "processing",
    "expectedResourceRevision": 1,
    "targetKind": "source_directory",
    "targetId": "directory-11111111-1111-4111-8111-111111111111",
    "candidateRelativePath": "handbook/archive",
    "result": null,
    "errorCode": null,
    "retryGuidance": "Check this change again after a short delay.",
    "actions": {
      "self": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/operations/directory-move-22222222-2222-4222-8222-222222222222"
    },
    "createdAt": "2026-06-17T00:00:00.000Z",
    "updatedAt": "2026-06-17T00:00:00.000Z",
    "completedAt": null
  }
}

Error Codes

The table below lists every error response documented for this operation.

HTTP Status	Error Code	Explanation
401	UNAUTHORIZED	The Bearer API key is missing, malformed, unknown, revoked, or deleted.
404	NOT_FOUND	The requested resource was not found.
409	CONFLICT	The request conflicts with the resource's current state.
413	PAYLOAD_TOO_LARGE	The request body or requested file exceeds the size limit for this operation.
422	VALIDATION_ERROR	The request failed validation.
429	RATE_LIMITED	The request exceeded the configured rate limits.
500	INTERNAL_ERROR	The API encountered an internal error.
503	DATABASE_REPOSITORY_UNAVAILABLE	The data required by this operation is temporarily unavailable.

Next Steps

• Get document indexing or resource change