Get document indexing or resource change

Interface Description

Use the operationId returned by an upload or resource change to read its processing state, progressive document counts, final result, and error details.

Endpoint

Field	Value
Method	GET
Path	/openapi/v2/knowledge-bases/{knowledgeBaseId}/operations/{operationId}
Operation ID	getResourceOperation
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.
operationId	path	Yes	string	source-move-11111111-1111-4111-8111-111111111111	Change identifier returned by file and directory move, replace, or delete requests.

Request Body

This operation has no request body.

Request Example

curl -X GET "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/operations/source-move-11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer <openapi-key>"

Successful Responses

200

Requested upload indexing or resource change.

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

Success Response Example

{
  "operation": {
    "operationId": "source-move-11111111-1111-4111-8111-111111111111",
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "kind": "source_file_move",
    "state": "processing",
    "expectedResourceRevision": 1,
    "targetKind": "source_file",
    "targetId": "source-file-11111111-1111-4111-8111-111111111111",
    "candidateRelativePath": "handbook/setup/install.md",
    "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/source-move-11111111-1111-4111-8111-111111111111"
    },
    "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.
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.