POpoll-the-people
Pages

Delete a document.

Changed on

Permanently removes a document from an agent's knowledge base. The agent will no longer reference this content when answering questions. Use this to remove outdated or incorrect information.

Warning: This action cannot be undone. The document must be re-uploaded or re-indexed to restore it.

delete/api/v1/projects/{projectId}/pages/{pageId}

Request

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

pageIdinteger required

The unique identifier of the page (document) to delete. Obtain page IDs from GET /api/v1/projects/{projectId}/pages.

Response

Agent deleted successfully

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "deleted": true
  }
}

Changes

  • 77aab4354382Revision changes
    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • info

      added the non-success response with the status

  • b80e6dfcf78dRevision changes
    • warning

      added the new Agent id is required enum value to the / response property for the response status

    • warning

      added the new Agent with id {projectId} not found enum value to the / response property for the response status

    • info

      removed the Project id is required enum value from the / response property for the response status

    • info

      removed the Project with id {projectId} not found enum value from the / response property for the response status