# Orthanc API API

> Orthanc API API on Apizie: 285 endpoints (List changes, Clear changes, List exports, Clear exports, …) returned as clean JSON through one API key. 285 endpoints are live now. Call it over REST at https://apizie.tech/v1/business:orthanc-server/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:orthanc-server`
- Category: Business
- Status: live
- Source: https://orthanc-server.com
- Page: https://apizie.tech/api/business/orthanc-server
- OpenAPI: https://apizie.tech/api/business/orthanc-server/openapi.json

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…

## Endpoints

### List changes
`GET https://apizie.tech/v1/business:orthanc-server/get-changes`

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | number | no | Limit the number of results |
| since | number | no | Show only the resources since the provided index |

### Clear changes
`POST https://apizie.tech/v1/business:orthanc-server/delete-changes`

### List exports
`GET https://apizie.tech/v1/business:orthanc-server/get-exports`

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | number | no | Limit the number of results |
| since | number | no | Show only the resources since the provided index |

### Clear exports
`POST https://apizie.tech/v1/business:orthanc-server/delete-exports`

### List the available instances
`GET https://apizie.tech/v1/business:orthanc-server/get-instances`

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand | string | no | If present, retrieve detailed information about the individual instances |
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| limit | number | no | Limit the number of results |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| since | number | no | Show only the resources since the provided index |

### Upload DICOM instances
`POST https://apizie.tech/v1/business:orthanc-server/post-instances`

### Get information about some instance
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| id | string | yes | Orthanc identifier of the instance of interest |

### Delete some instance
`POST https://apizie.tech/v1/business:orthanc-server/delete-instances-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |

### Anonymize instance
`POST https://apizie.tech/v1/business:orthanc-server/post-instances-id-anonymize`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| body | object | no | JSON request body |

### List attachments
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | string | no | If present, retrieve the attachments list and their numerical ids |
| id | string | yes | Orthanc identifier of the instance of interest |

### List operations on attachments
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Set attachment
`POST https://apizie.tech/v1/business:orthanc-server/put-instances-id-attachments-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the attachment, if this is not the first time this attachment is set. |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Delete attachment
`POST https://apizie.tech/v1/business:orthanc-server/delete-instances-id-attachments-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions`… |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Compress attachment
`POST https://apizie.tech/v1/business:orthanc-server/post-instances-id-attachments-name-compress`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get attachment (no decompression)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-compressed-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the metadata, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get MD5 of attachment on disk
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-compressed-md5`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get size of attachment on disk
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-compressed-size`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the metadata, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get info about the attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-info`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Is attachment compressed?
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-is-compressed`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get MD5 of attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-md5`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get size of attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-attachments-name-size`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Uncompress attachment
`POST https://apizie.tech/v1/business:orthanc-server/post-instances-id-attachments-name-uncompress`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Verify attachment
`POST https://apizie.tech/v1/business:orthanc-server/post-instances-id-attachments-name-verify-md5`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get raw tag
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-content`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ... | string | yes | Path to the DICOM tag. This is the interleaving of one DICOM tag, possibly followed by an index for sequences. Sequences are accessible… |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Write DICOM onto filesystem
`POST https://apizie.tech/v1/business:orthanc-server/post-instances-id-export`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Download DICOM
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-file`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### List available frames
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### List operations
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame`

| Parameter | Type | Required | Description |
|---|---|---|---|
| frame | string | yes |  |
| id | string | yes |  |

### Decode a frame (int16)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-image-int16`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Decode a frame (uint16)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-image-uint16`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Decode a frame (uint8)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-image-uint8`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Decode frame for Matlab
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-matlab`

| Parameter | Type | Required | Description |
|---|---|---|---|
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Decode frame for numpy
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-numpy`

| Parameter | Type | Required | Description |
|---|---|---|---|
| compress | boolean | no | Compress the file as `.npz` |
| rescale | boolean | no | On grayscale images, apply the rescaling and return floating-point values |
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the DICOM resource of interest |

### Decode a frame (preview)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-preview`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Access raw frame
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-raw`

| Parameter | Type | Required | Description |
|---|---|---|---|
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the instance of interest |

### Access raw frame (compressed)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-raw-gz`

| Parameter | Type | Required | Description |
|---|---|---|---|
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the instance of interest |

### Render a frame
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-frames-frame-rendered`

| Parameter | Type | Required | Description |
|---|---|---|---|
| height | number | no | Height of the resized image |
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| smooth | boolean | no | Whether to smooth image on resize |
| width | number | no | Width of the resized image |
| window-center | number | no | Windowing center |
| window-width | number | no | Windowing width |
| frame | number | yes | Index of the frame (starts at `0`) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Get DICOM meta-header
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-header`

| Parameter | Type | Required | Description |
|---|---|---|---|
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| simplify | boolean | no | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Decode an image (int16)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-image-int16`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Decode an image (uint16)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-image-uint16`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Decode an image (uint8)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-image-uint8`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### List labels
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-labels`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |

### Test label
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-labels-label`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| label | string | yes | The label of interest |

### Add label
`POST https://apizie.tech/v1/business:orthanc-server/put-instances-id-labels-label`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| label | string | yes | The label to be added |

### Remove label
`POST https://apizie.tech/v1/business:orthanc-server/delete-instances-id-labels-label`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| label | string | yes | The label to be removed |

### Decode frame for Matlab
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-matlab`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### List metadata
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-metadata`

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand | string | no | If present, also retrieve the value of the individual metadata |
| numeric | string | no | If present, use the numeric identifier of the metadata instead of its symbolic name |
| id | string | yes | Orthanc identifier of the instance of interest |

### Get metadata
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-metadata-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the metadata, to check if its content has changed |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the metadata, or its index (cf. `UserMetadata` configuration option) |

### Set metadata
`POST https://apizie.tech/v1/business:orthanc-server/put-instances-id-metadata-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the metadata, if this is not the first time this metadata is set. |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the metadata, or its index (cf. `UserMetadata` configuration option) |

### Delete metadata
`POST https://apizie.tech/v1/business:orthanc-server/delete-instances-id-metadata-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option… |
| id | string | yes | Orthanc identifier of the instance of interest |
| name | string | yes | The name of the metadata, or its index (cf. `UserMetadata` configuration option) |

### Modify instance
`POST https://apizie.tech/v1/business:orthanc-server/post-instances-id-modify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| body | object | no | JSON request body |

### Get instance module
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-module`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ignore-length | array | no | Also include the DICOM tags that are provided in this list, even if their associated value is long |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| simplify | boolean | no | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) |
| id | string | yes | Orthanc identifier of the instance of interest |

### Decode instance for numpy
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-numpy`

| Parameter | Type | Required | Description |
|---|---|---|---|
| compress | boolean | no | Compress the file as `.npz` |
| rescale | boolean | no | On grayscale images, apply the rescaling and return floating-point values |
| id | string | yes | Orthanc identifier of the DICOM resource of interest |

### Get parent patient
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-patient`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| id | string | yes | Orthanc identifier of the instance of interest |

### Get embedded PDF
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-pdf`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance interest |

### Decode an image (preview)
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-preview`

| Parameter | Type | Required | Description |
|---|---|---|---|
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Reconstruct tags & optionally files of instance
`POST https://apizie.tech/v1/business:orthanc-server/post-instances-id-reconstruct`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |
| body | object | no | JSON request body |

### Render an image
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-rendered`

| Parameter | Type | Required | Description |
|---|---|---|---|
| height | number | no | Height of the resized image |
| quality | number | no | Quality for JPEG images (between 1 and 100, defaults to 90) |
| returnUnsupportedImage | boolean | no | Returns an unsupported.png placeholder image if unable to provide the image instead of returning a 415 HTTP error (defaults to false) |
| smooth | boolean | no | Whether to smooth image on resize |
| width | number | no | Width of the resized image |
| window-center | number | no | Windowing center |
| window-width | number | no | Windowing width |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Get parent series
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-series`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| id | string | yes | Orthanc identifier of the instance of interest |

### Get human-readable tags
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-simplified-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ignore-length | array | no | Also include the DICOM tags that are provided in this list, even if their associated value is long |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### Get instance statistics
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-statistics`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the instance of interest |

### Get parent study
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-study`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| id | string | yes | Orthanc identifier of the instance of interest |

### Get DICOM tags
`GET https://apizie.tech/v1/business:orthanc-server/get-instances-id-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ignore-length | array | no | Also include the DICOM tags that are provided in this list, even if their associated value is long |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| simplify | boolean | no | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) |
| id | string | yes | Orthanc identifier of the DICOM instance of interest |

### List jobs
`GET https://apizie.tech/v1/business:orthanc-server/get-jobs`

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand | string | no | If present, retrieve detailed information about the individual jobs |

### Get job
`GET https://apizie.tech/v1/business:orthanc-server/get-jobs-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the job of interest |

### Cancel job
`POST https://apizie.tech/v1/business:orthanc-server/post-jobs-id-cancel`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the job of interest |

### Pause job
`POST https://apizie.tech/v1/business:orthanc-server/post-jobs-id-pause`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the job of interest |

### Resubmit job
`POST https://apizie.tech/v1/business:orthanc-server/post-jobs-id-resubmit`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the job of interest |

### Resume job
`POST https://apizie.tech/v1/business:orthanc-server/post-jobs-id-resume`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the job of interest |

### Get job output
`GET https://apizie.tech/v1/business:orthanc-server/get-jobs-id-key`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the job of interest |
| key | string | yes | Name of the output of interest |

### List DICOM modalities
`GET https://apizie.tech/v1/business:orthanc-server/get-modalities`

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand | string | no | If present, retrieve detailed information about the individual DICOM modalities |

### List operations on modality
`GET https://apizie.tech/v1/business:orthanc-server/get-modalities-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the DICOM modality of interest |

### Update DICOM modality
`POST https://apizie.tech/v1/business:orthanc-server/put-modalities-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the new/updated DICOM modality |
| body | object | no | JSON request body |

### Delete DICOM modality
`POST https://apizie.tech/v1/business:orthanc-server/delete-modalities-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the DICOM modality of interest |

### Get modality configuration
`GET https://apizie.tech/v1/business:orthanc-server/get-modalities-id-configuration`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |

### Trigger C-ECHO SCU
`POST https://apizie.tech/v1/business:orthanc-server/post-modalities-id-echo`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |
| body | object | no | JSON request body |

### C-FIND SCU for worklist
`POST https://apizie.tech/v1/business:orthanc-server/post-modalities-id-find-worklist`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |
| body | object | no | JSON request body |

### Trigger C-MOVE SCU
`POST https://apizie.tech/v1/business:orthanc-server/post-modalities-id-move`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |
| body | object | no | JSON request body |

### Trigger C-FIND SCU
`POST https://apizie.tech/v1/business:orthanc-server/post-modalities-id-query`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |
| body | object | no | JSON request body |

### Trigger storage commitment request
`POST https://apizie.tech/v1/business:orthanc-server/post-modalities-id-storage-commitment`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |
| body | object | no | JSON request body |

### Trigger C-STORE SCU
`POST https://apizie.tech/v1/business:orthanc-server/post-modalities-id-store`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |
| body | object | no | JSON request body |

### Straight C-STORE SCU
`POST https://apizie.tech/v1/business:orthanc-server/post-modalities-id-store-straight`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Identifier of the modality of interest |

### List the available patients
`GET https://apizie.tech/v1/business:orthanc-server/get-patients`

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand | string | no | If present, retrieve detailed information about the individual patients |
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| limit | number | no | Limit the number of results |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| since | number | no | Show only the resources since the provided index |

### Get information about some patient
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| id | string | yes | Orthanc identifier of the patient of interest |

### Delete some patient
`POST https://apizie.tech/v1/business:orthanc-server/delete-patients-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |

### Anonymize patient
`POST https://apizie.tech/v1/business:orthanc-server/post-patients-id-anonymize`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| body | object | no | JSON request body |

### Create ZIP archive
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-archive`

| Parameter | Type | Required | Description |
|---|---|---|---|
| filename | string | no | Filename to set in the "Content-Disposition" HTTP header (including file extension) |
| transcode | string | no | If present, the DICOM files in the archive will be transcoded to the provided transfer syntax:… |
| id | string | yes | Orthanc identifier of the patient of interest |

### Create ZIP archive
`POST https://apizie.tech/v1/business:orthanc-server/post-patients-id-archive`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| body | object | no | JSON request body |

### List attachments
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | string | no | If present, retrieve the attachments list and their numerical ids |
| id | string | yes | Orthanc identifier of the patient of interest |

### List operations on attachments
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Set attachment
`POST https://apizie.tech/v1/business:orthanc-server/put-patients-id-attachments-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the attachment, if this is not the first time this attachment is set. |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Delete attachment
`POST https://apizie.tech/v1/business:orthanc-server/delete-patients-id-attachments-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the attachment, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions`… |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Compress attachment
`POST https://apizie.tech/v1/business:orthanc-server/post-patients-id-attachments-name-compress`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get attachment (no decompression)
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-compressed-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the metadata, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get MD5 of attachment on disk
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-compressed-md5`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get size of attachment on disk
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-compressed-size`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the metadata, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get info about the attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-info`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Is attachment compressed?
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-is-compressed`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get MD5 of attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-md5`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get size of attachment
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-attachments-name-size`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the attachment, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Uncompress attachment
`POST https://apizie.tech/v1/business:orthanc-server/post-patients-id-attachments-name-uncompress`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Verify attachment
`POST https://apizie.tech/v1/business:orthanc-server/post-patients-id-attachments-name-verify-md5`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the attachment, or its index (cf. `UserContentType` configuration option) |

### Get child instances
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-instances`

| Parameter | Type | Required | Description |
|---|---|---|---|
| full | boolean | no | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their… |
| requestedTags | string | no | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers;… |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| id | string | yes | Orthanc identifier of the patient of interest |

### Get tags of instances
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-instances-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ignore-length | array | no | Also include the DICOM tags that are provided in this list, even if their associated value is long |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| simplify | boolean | no | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) |
| id | string | yes | Orthanc identifier of the patient of interest |

### List labels
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-labels`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |

### Test label
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-labels-label`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| label | string | yes | The label of interest |

### Add label
`POST https://apizie.tech/v1/business:orthanc-server/put-patients-id-labels-label`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| label | string | yes | The label to be added |

### Remove label
`POST https://apizie.tech/v1/business:orthanc-server/delete-patients-id-labels-label`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| label | string | yes | The label to be removed |

### Create DICOMDIR media
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-media`

| Parameter | Type | Required | Description |
|---|---|---|---|
| extended | string | no | If present, will include additional tags such as `SeriesDescription`, leading to a so-called *extended DICOMDIR* |
| filename | string | no | Filename to set in the "Content-Disposition" HTTP header (including file extension) |
| transcode | string | no | If present, the DICOM files in the archive will be transcoded to the provided transfer syntax:… |
| id | string | yes | Orthanc identifier of the patient of interest |

### Create DICOMDIR media
`POST https://apizie.tech/v1/business:orthanc-server/post-patients-id-media`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| body | object | no | JSON request body |

### List metadata
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-metadata`

| Parameter | Type | Required | Description |
|---|---|---|---|
| expand | string | no | If present, also retrieve the value of the individual metadata |
| numeric | string | no | If present, use the numeric identifier of the metadata instead of its symbolic name |
| id | string | yes | Orthanc identifier of the patient of interest |

### Get metadata
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-metadata-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-None-Match | string | no | Optional revision of the metadata, to check if its content has changed |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the metadata, or its index (cf. `UserMetadata` configuration option) |

### Set metadata
`POST https://apizie.tech/v1/business:orthanc-server/put-patients-id-metadata-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the metadata, if this is not the first time this metadata is set. |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the metadata, or its index (cf. `UserMetadata` configuration option) |

### Delete metadata
`POST https://apizie.tech/v1/business:orthanc-server/delete-patients-id-metadata-name`

| Parameter | Type | Required | Description |
|---|---|---|---|
| If-Match | string | no | Revision of the metadata, to check if its content has not changed and can be deleted. This header is mandatory if `CheckRevisions` option… |
| id | string | yes | Orthanc identifier of the patient of interest |
| name | string | yes | The name of the metadata, or its index (cf. `UserMetadata` configuration option) |

### Modify patient
`POST https://apizie.tech/v1/business:orthanc-server/post-patients-id-modify`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |
| body | object | no | JSON request body |

### Get patient module
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-module`

| Parameter | Type | Required | Description |
|---|---|---|---|
| ignore-length | array | no | Also include the DICOM tags that are provided in this list, even if their associated value is long |
| short | boolean | no | If present, report the DICOM tags in hexadecimal format |
| simplify | boolean | no | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) |
| id | string | yes | Orthanc identifier of the patient of interest |

### Is the patient protected against recycling?
`GET https://apizie.tech/v1/business:orthanc-server/get-patients-id-protected`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |

### Protect one patient against recycling
`POST https://apizie.tech/v1/business:orthanc-server/put-patients-id-protected`

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Orthanc identifier of the patient of interest |

…and 165 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/business:orthanc-server/get-changes" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Orthanc API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/business:orthanc-server/get-changes with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Orthanc API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Orthanc API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:orthanc-server.

### What is the status of the Orthanc API API?
Live: works with just an Apizie key