Skip to main content

DELETE /api/v1/session//documentation

Deletes all documentation items from the session. This removes all scraped and uploaded documentation chunks but preserves the session itself and other session data.

Path Parameters

session_id
string
required
The UUID of the session to delete documentation from

Response

message
string
Success message indicating documentation was deleted
sessionId
string
The session UUID
deletedCount
number
The number of documentation items that were deleted

Example Request

curl -X DELETE http://localhost:8090/api/v1/session/550e8400-e29b-41d4-a716-446655440000/documentation

Example Response

{
  "message": "All documentation deleted successfully",
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "deletedCount": 42
}

Error Responses

404
error
Session not found
{
  "detail": "Session 550e8400-e29b-41d4-a716-446655440000 not found"
}

Notes

  • This operation deletes all documentation items (chunks) from the session
  • The session itself remains intact with all other data preserved
  • Extraction results (object classes, attributes, etc.) derived from the documentation are not automatically deleted
  • To start fresh with new documentation, delete the old documentation first, then upload or scrape new docs
Deleting documentation cannot be undone. Any extraction results based on this documentation will remain in the session but cannot be regenerated without re-adding the documentation.

Use Cases

  • Clear documentation before uploading a new version
  • Remove irrelevant scraped documentation
  • Reset the session to start the workflow over with different documentation
  • Clean up test data

Build docs developers (and LLMs) love