DeleteDocument

Updated at:

Deletes a document from a specified knowledge base.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

KbUuid

string

Yes

The knowledge base ID.

kb-***

DocumentName

string

Yes

The document name.

test.md

Response elements

Element

Type

Description

Example

object

The response body.

RequestId

string

The unique request ID. Use this ID to troubleshoot errors.

67E910F2-4B62-5B0C-ACA3-7547695C****

Data

boolean

Indicates whether the document was deleted. Valid values:

  • true: The deletion was successful.

  • false: The deletion failed.

true

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

ErrorCode

string

The error code that is returned if the request fails.

KnowledgeBaseNotFound

ErrorMessage

string

The error message that is returned if the request fails.

Resource not found kb-***

Examples

Success response

JSON format

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Data": true,
  "Success": true,
  "ErrorCode": "KnowledgeBaseNotFound",
  "ErrorMessage": "Resource not found kb-***\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.