Skip to content

Retry uploaded file ​

Interface Description ​

Manually retry one uploaded Markdown file that failed processing.

Endpoint ​

FieldValue
MethodPOST
Path/openapi/v2/knowledge-bases/{knowledgeBaseId}/source-files/{sourceFileId}/retry
Operation IDretryKnowledgeBaseSourceFile
AuthenticationBearer OpenAPI key

Parameters ​

NameLocationRequiredTypeExampleDescription
knowledgeBaseIdpathYesstringknowledge-base-11111111-1111-4111-8111-111111111111Knowledge-base identifier returned by knowledge-base APIs.
sourceFileIdpathYesstringsource-file-11111111-1111-4111-8111-111111111111Uploaded-file identifier returned by upload or uploaded-file list APIs.

Request Body ​

This operation has no request body.

Request Example ​

bash
curl -X POST "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/source-files/source-file-11111111-1111-4111-8111-111111111111/retry" \
  -H "Authorization: Bearer <openapi-key>"

Successful Responses ​

202 ​

Uploaded file and accepted retry details.

FieldRequiredTypeDescription
sourceFileYesobjectUploaded Markdown file returned by the request.
retryYesobjectRetry request accepted by the server.

Success Response Example ​

json
{
  "sourceFile": {
    "sourceFileId": "source-file-11111111-1111-4111-8111-111111111111",
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "directoryId": "directory-11111111-1111-4111-8111-111111111111",
    "name": "guide.md",
    "relativePath": "handbook/guide.md",
    "generatedPath": "pages/handbook/guide.md",
    "contentType": "text/markdown; charset=utf-8",
    "sizeBytes": 1024,
    "resourceRevision": 1,
    "contentRevision": 1,
    "state": "waiting",
    "workProgress": {
      "required": 8,
      "completed": 0,
      "activeKinds": [],
      "blockingKind": "prepare",
      "retryingKind": null
    },
    "failure": null,
    "generatedOutputStatus": "unavailable",
    "actions": [],
    "links": {
      "self": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/source-files/source-file-11111111-1111-4111-8111-111111111111",
      "generatedContent": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/files/content?path=pages%2Fhandbook%2Fguide.md",
      "search": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/files/search?query=guide.md"
    },
    "createdAt": "2026-06-17T00:00:00.000Z"
  },
  "retry": {
    "kind": "document_processing",
    "scope": "source_file",
    "coalesced": false
  }
}

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.
409CONFLICTThe request conflicts with the resource's current state.
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 ​