{"@context": "https://schema.org", "@type": "WebAPI", "name": "Orthanc API API", "description": "This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.An e", "provider": {"@type": "Organization", "name": "orthanc-server.com"}, "documentation": "https://api.orthanc-server.com/orthanc-openapi.json"}
Index / APIs / orthanc-server.com

Orthanc API API

This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.An e

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://demo.orthanc-server.com

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

Orthanc API v1.11.3

This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) of Orthanc.This reference is automatically generated from the source code of Orthanc. A [shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of the Orthanc Book.An earlier, manually crafted version from August 2019, is [still available](2019-08-orthanc-openapi.html

methodpathwhat the vendor says it does
GET/changesList changes Whenever Orthanc receives a new DICOM instance, this event is recorded in the so-called _Changes
DELETE/changesClear changes Clear the full history stored in the changes log Tracking changes
GET/exportsList exports For medical traceability, Orthanc can be configured to store a log of all the resources that have
DELETE/exportsClear exports Clear the full history stored in the exports log Tracking changes
GET/instancesList the available instances List the Orthanc identifiers of all the available DICOM instances Instances
POST/instancesUpload DICOM instances Upload DICOM instances Instances
GET/instances/{id}Get information about some instance Get detailed information about the DICOM instance whose Orthanc identifier
DELETE/instances/{id}Delete some instance Delete the DICOM instance whose Orthanc identifier is provided in the URL Instances
POST/instances/{id}/anonymizeAnonymize instance Download an anonymized version of the DICOM instance whose Orthanc identifier is provided i
GET/instances/{id}/attachmentsList attachments Get the list of attachments that are associated with the given instance Instances
GET/instances/{id}/attachments/{name}List operations on attachments Get the list of the operations that are available for attachments associated wi
PUT/instances/{id}/attachments/{name}Set attachment Attach a file to the given DICOM instance. This call will fail if trying to modify a system att
DELETE/instances/{id}/attachments/{name}Delete attachment Delete an attachment associated with the given DICOM instance. This call will fail if trying
POST/instances/{id}/attachments/{name}/compressCompress attachment Change the compression scheme that is used to store an attachment. Instances
GET/instances/{id}/attachments/{name}/compressed-dataGet attachment (no decompression) Get the (binary) content of one attachment associated with the given instanc
GET/instances/{id}/attachments/{name}/compressed-md5Get MD5 of attachment on disk Get the MD5 hash of one attachment associated with the given instance, as stored
GET/instances/{id}/attachments/{name}/compressed-sizeGet size of attachment on disk Get the size of one attachment associated with the given instance, as stored on
GET/instances/{id}/attachments/{name}/dataGet attachment Get the (binary) content of one attachment associated with the given instance Instances
GET/instances/{id}/attachments/{name}/infoGet info about the attachment Get all the information about the attachment associated with the given instance
GET/instances/{id}/attachments/{name}/is-compressedIs attachment compressed? Test whether the attachment has been stored as a compressed file on the disk. Instan
GET/instances/{id}/attachments/{name}/md5Get MD5 of attachment Get the MD5 hash of one attachment associated with the given instance Instances
GET/instances/{id}/attachments/{name}/sizeGet size of attachment Get the size of one attachment associated with the given instance Instances
POST/instances/{id}/attachments/{name}/uncompressUncompress attachment Change the compression scheme that is used to store an attachment. Instances
POST/instances/{id}/attachments/{name}/verify-md5Verify attachment Verify that the attachment is not corrupted, by validating its MD5 hash Instances
GET/instances/{id}/contentGet raw tag Get the raw content of one DICOM tag in the hierarchy of DICOM dataset Instances
POST/instances/{id}/exportWrite DICOM onto filesystem Write the DICOM file onto the filesystem where Orthanc is running Instances
GET/instances/{id}/fileDownload DICOM Download one DICOM instance Instances
GET/instances/{id}/framesList available frames List the frames that are available in the DICOM instance of interest Instances
GET/instances/{id}/frames/{frame}List operations List the available operations under URI `/instances/{id}/frames/{frame}/` Other
GET/instances/{id}/frames/{frame}/image-int16Decode a frame (int16) Decode one frame of interest from the given DICOM instance. Pixels of grayscale images
GET/instances/{id}/frames/{frame}/image-uint16Decode a frame (uint16) Decode one frame of interest from the given DICOM instance. Pixels of grayscale images
GET/instances/{id}/frames/{frame}/image-uint8Decode a frame (uint8) Decode one frame of interest from the given DICOM instance. Pixels of grayscale images
GET/instances/{id}/frames/{frame}/matlabDecode frame for Matlab Decode one frame of interest from the given DICOM instance, and export this frame as a
GET/instances/{id}/frames/{frame}/numpyDecode frame for numpy Decode one frame of interest from the given DICOM instance, for use with numpy in Pytho
GET/instances/{id}/frames/{frame}/previewDecode a frame (preview) Decode one frame of interest from the given DICOM instance. The full dynamic range of
GET/instances/{id}/frames/{frame}/rawAccess raw frame Access the raw content of one individual frame of the DICOM instance of interest, bypassing i
GET/instances/{id}/frames/{frame}/raw.gzAccess raw frame (compressed) Access the raw content of one individual frame of the DICOM instance of interest
GET/instances/{id}/frames/{frame}/renderedRender a frame Render one frame of interest from the given DICOM instance. This function takes scaling into ac
GET/instances/{id}/headerGet DICOM meta-header Get the DICOM tags in the meta-header of the DICOM instance. By default, the `full` form
GET/instances/{id}/image-int16Decode an image (int16) Decode the first frame of the given DICOM instance. Pixels of grayscale images are tru

and 160 more operation(s) in this specification, all searchable.

specification origin: https://api.orthanc-server.com/orthanc-openapi.json

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.