Skip to main content

​
GET /api/v1/session//documentation

Retrieves all documentation items (chunks) stored in the session. This includes both scraped documentation from URLs and uploaded documentation files.

​
Path Parameters

​
session_id
string
required
The UUID of the session to retrieve documentation from

​
Response

​
sessionId
string
The session UUID
​
documentationItems
array
Array of documentation item objects
​
count
number
Total number of documentation items

​
Example Request

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

​
Example Response

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "count": 3,
  "documentationItems": [
    {
      "uuid": "doc-uuid-1",
      "url": "https://api.example.com/docs/authentication",
      "markdown": "# Authentication\n\nOur API uses OAuth 2.0...",
      "app": "ExampleAPI",
      "appVersion": "v2.1",
      "source": "scrape",
      "tags": ["authentication", "oauth", "security"],
      "category": "reference_api"
    },
    {
      "uuid": "doc-uuid-2",
      "url": "openapi.yaml",
      "markdown": "openapi: 3.0.0\ninfo:\n  title: Example API...",
      "app": "ExampleAPI",
      "appVersion": "v2.1",
      "source": "upload",
      "tags": ["openapi", "specification"],
      "category": "spec_yaml"
    }
  ]
}

​
Error Responses

​
404
error
Session not found or no documentation exists in the session
{
  "detail": "No documentation found in session 550e8400-e29b-41d4-a716-446655440000"
}

​
Notes

  • Documentation items are chunks of the original documents
  • Each chunk has a maximum size configured by the system (default: 20,000 tokens)
  • Tags and categories are extracted during the processing phase
  • The source field indicates whether the documentation was scraped from URLs or uploaded directly

​
Use Cases

  • Verify that documentation was successfully processed
  • Review what documentation is available before running digester operations
  • Export documentation for offline analysis
  • Debug issues with documentation processing

Build docs developers (and LLMs) love

Get started for freeTalk to us