GRgroundxai
Documents

delete (singular)

Changed on

Delete a single document hosted on GroundX

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

delete/v1/ingest/document/{documentId}

Request

  • Base URL
    https://api.groundx.ai/api
  • URL
    https://api.groundx.ai/api/v1/ingest/document/{documentId}
  • Auth
    API key in header X-API-Key

Path parameters

documentIdstring uuid required

A documentId which correspond to a document ingested by GroundX

Response

Document successfully deleted

Changes

  • 03c394f90d6bRevision changes
    • info

      api operation id Document_delete removed and replaced with Document_delete1

  • bf7061385e18Revision changes
    • breaking

      for the path request parameter documentId, the format changed from no format to uuid

    • warning

      removed the optional property from the response with the status

    • info

      added the required property to the response with the status