Skip to content

List document indexing and resource changes ​

Interface Description ​

List upload indexing and file or directory changes for a knowledge base. Results can be filtered by processing status.

Endpoint ​

FieldValue
MethodGET
Path/openapi/v2/knowledge-bases/{knowledgeBaseId}/operations
Operation IDlistResourceOperations
AuthenticationBearer OpenAPI key

Parameters ​

NameLocationRequiredTypeExampleDescription
knowledgeBaseIdpathYesstringknowledge-base-11111111-1111-4111-8111-111111111111Knowledge-base identifier returned by knowledge-base APIs.
statequeryNoprocessing | completed | failed | cancelled | supersededprocessingOptional operation-state filter.
limitqueryNointeger50Maximum number of records to return. The deployment can enforce a lower limit.
cursorqueryNostringcursor_123Pagination token returned by the same endpoint for reading the next page.

Request Body ​

This operation has no request body.

Request Example ​

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

Successful Responses ​

200 ​

Requested page of upload indexing and resource changes.

FieldRequiredTypeDescription
itemsYesarray<ResourceOperation>Records returned on this page.
nextCursorYesstring | nullPagination token returned by this endpoint. Reuse it only with the same endpoint and unchanged filters. If it is rejected, restart without a cursor.

Success Response Example ​

json
{
  "items": [
    {
      "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
    }
  ],
  "nextCursor": null
}

Error Codes ​

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

HTTP StatusError CodeExplanation
401UNAUTHORIZEDThe Bearer API key is missing, malformed, unknown, revoked, or deleted.
404NOT_FOUNDThe requested resource was not found.
422VALIDATION_ERRORThe request failed validation.
429RATE_LIMITEDThe request exceeded the configured rate limits.
500INTERNAL_ERRORThe API encountered an internal error.
503DATABASE_REPOSITORY_UNAVAILABLEThe data required by this operation is temporarily unavailable.

Next Steps ​