This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A [shorter ch
Full LLM thinking from the 4-phase benchmark pipeline.
{
"service_type": "platform",
"base_url": "https://orthanc-server.com",
"auth_method": "none",
"auth_config": {
"note": "Default open-access via REST; optional HTTP Basic auth and user/roles plugin can be enabled by the instance administrator. Authentication is not enforced on a stock public deployment."
},
"endpoints": [],
"pricing_model": {
"type": "free",
"details": {
"license": "GPLv3 (with optional commercial licensing available)",
"deployment": "Self-hosted open-source server; no vendor SaaS pricing",
"note": "Orthanc is free software; costs are limited to your own hosting. Commercial support exists via Osimis/Orthanc team."
}
},
"rate_limits": {},
"capabilities": [
"DICOM store (C-STORE) and retrieval (C-FIND/C-MOVE/C-GET)",
"DICOMweb (QIDO-RS, WADO-RS, STOW-RS, WADO-URI)",
"RESTful API for patients, studies, series, instances",
"JPEG/PNG image rendering and transcoding",
"DICOM anonymization and modification",
"Web viewer (Orthanc Explorer)",
"Plugin ecosystem (MySQL/PostgreSQL, DICOMweb, Web viewer, Worklists, Advanced Authorization)",
"DICOM tag-based querying and metadata access",
"Backup/export to filesystem or archive (ZIP)",
"Lua/Python scripting for automation",
"Peer-to-peer orthanc-to-orthanc synchronization",
"Job management API for long-running tasks"
],
"raw_analysis": "Orthanc is an open-source, lightweight DICOM server and medical imaging platform developed by the Orthanc team (Sébastien Jodogne) and widely used in radiology, research, teleradiology, and healthcare IT. It exposes a comprehensive REST API documented at book.orthanc-server.com/users/rest.html and an auto-generated reference from the source code.\n\nWhat it does: Acts as a full-featured DICOM storage service (PACS-lite) with REST, DICOMweb, and C-STORE/C-FIND/C-MOVE/C-GET support. It lets clients create, query, retrieve, modify, anonymize, and delete DICOM patients/studies/series/instances, render previews, run transcoding jobs, and orchestrate long-running operations via a Job API.\n\nWho it's for: Hospitals and clinics needing a lightweight PACS, researchers handling medical imaging datasets, developers building imaging workflows/ML pipelines, and integrators needing an embeddable DICOM engine. It's commonly used as a bridge between DICOM modalities and web/ML services.\n\nMaturity: Very mature and battle-tested (years of releases, large plugin ecosystem, commercial backers, and production deployments). Documentation is thorough (book, API reference, plugins).\n\nIntegrations: DICOMweb (with the DICOMweb plugin), MySQL/PostgreSQL storage backends, Web viewer, Worklists (modality worklist), Python/Lua scripting, Docker images, and orthanc-to-orthanc peering. The REST API is simple HTTP (JSON) and easy to call from any language.\n\nPricing: Free (GPLv3) as self-hosted software; optional commercial support/licensing. No built-in public SaaS, so no per-call pricing or published rate limits — throughput depends on your deployment. Rate limiting, if any, would be applied by your reverse proxy or the Advanced Authorization plugin.\n\nAuth: Out of the box the REST API is unauthenticated; production deployments typically front it with HTTP Basic auth (AuthenticationEnabled), TLS, and the authorization/advanced-authorization plugins. Since a generic analysis cannot assume the operator enabled those, auth_method is reported as 'none' at the protocol level with that caveat.\n\nEndpoints are intentionally left as an empty array here because this entry is a documentation pointer to a self-hosted platform rather than a fixed public service base URL; concrete routes (e.g., /patients, /studies, /instances, /tools/find, /dicom-web/studies) are defined per deployment."
}1/3 tests passed
| Test | Endpoint | Status | Latency |
|---|---|---|---|
| website_uptime | GET / | 200 | 366ms |
| robots_txt | GET /robots.txt | 404 | 116ms |
| llms_txt | GET /llms.txt | 404 | 115ms |
```json
{
"overall": 74,
"dimensions": {
"token_efficiency": 9.0,
"first_try_success": 6.0,
"response_parseability": 9.0,
"error_clarity": 8.0,
"doc_quality": 8.5,
"auth_simplicity": 7.0,
"latency": 9.0,
"consistency": 8.5
},
"pricing_normalized": {
"model": "free_open_source",
"self_hosted": true,
"commercial_support_optional": true,
"notes": "GPLv3; no SaaS pricing. Cost = hosting + optional Osimis support."
},
"issues": [
"Self-hosted only — no managed endpoint, so an agent cannot 'just call an API' without the user provisioning a server",
"No /robots.txt or /llms.txt (both 404) — agent-discovery surface is weak",
"No security headers on the marketing site",
"Onboarding requires Docker/binary install, plugin config, and TLS setup before first DICOM interaction",
"Licensing nuance (GPLv3 vs commercial) can be a decision blocker for some users"
],
"recommendations": [
"Publish /llms.txt summarizing the REST API endpoints, DICOMweb routes, and auth model for agent consumption",
"Offer a hosted sandbox/demo instance so agents and users can test API calls without provisioning",
"Add a concise OpenAPI/Swagger spec public URL — Orthanc already ships one internally",
"Clarify in docs the exact auth options (none for read-only in some configs, Basic auth, Advanced Authorization plugin) in a single table",
"Add security headers (HSTS, CSP, X-Content-Type-Options) to the main site",
"Provide a single-page 'quickstart to first STOW-RS call' guide — current docs spread this across multiple pages"
]
}
```Show your live agent-readiness score on your own site. Free, no auth — it updates as your score changes.
<a href="https://prowl.world/service/orthanc-api">
<img src="https://prowl.world/badge/orthanc-api.svg" height="56" alt="Agent-readiness on Prowl">
</a>
See operational metrics, LLM evaluations, agent readiness, and more.
Open in Dashboard