UI & Documentation

UI and documentation endpoints for serving the application homepage, observability dashboard, and static documentation files.

Authentication

None

No authentication required for UI and documentation endpoints

Endpoints

Documentation

GET

/atlandocs/*

Serve auto-generated static documentation files including API references, code examples, and integration guides. Content is dynamically generated by AtlanDocsGenerator from code annotations and configuration metadata.

Response

200Static HTML/CSS/JS files for documentation

Error Codes

404

Not Found

Requested documentation file or UI resource does not exist in the static file system or has been moved

500

Internal Server Error

Server encountered an error while reading or serving static documentation files or UI assets

Code examples - Documentation

cURL

BASH Request (cURL)

curl -X GET "http://localhost:8000/atlandocs/index.html"

JavaScript

JavaScript Request (JavaScript)

const response = await fetch('http://localhost:8000/atlandocs/index.html', {
method: 'GET'
});

const docsHtml = await response.text();
console.log('Documentation loaded');

Python

Python Request (Python)

import requests

response = requests.get('http://localhost:8000/atlandocs/index.html')
docs_content = response.text
print("Documentation loaded successfully")