UCLouvain

UCLouvain Instances API

The Instances API from UCLouvain — 51 operation(s) for instances.

GitHub OpenAPI

Operations 58

GET /instances List the available instances #
POST /instances Upload DICOM instances #
DELETE /instances/{id} Delete some instance #
GET /instances/{id} Get information about some instance #
POST /instances/{id}/anonymize Anonymize instance #
GET /instances/{id}/attachments List attachments #
DELETE /instances/{id}/attachments/{name} Delete attachment #
PUT /instances/{id}/attachments/{name} Set attachment #
POST /instances/{id}/attachments/{name}/compress Compress attachment #
GET /instances/{id}/attachments/{name}/compressed-data Get attachment (no decompression) #
GET /instances/{id}/attachments/{name}/compressed-md5 Get MD5 of attachment on disk #
GET /instances/{id}/attachments/{name}/compressed-size Get size of attachment on disk #
GET /instances/{id}/attachments/{name}/data Get attachment #
GET /instances/{id}/attachments/{name}/info Get info about the attachment #
GET /instances/{id}/attachments/{name}/is-compressed Is attachment compressed? #
GET /instances/{id}/attachments/{name}/md5 Get MD5 of attachment #
GET /instances/{id}/attachments/{name}/size Get size of attachment #
POST /instances/{id}/attachments/{name}/uncompress Uncompress attachment #
POST /instances/{id}/attachments/{name}/verify-md5 Verify attachment #
GET /instances/{id}/content/{path} Get raw tag #
POST /instances/{id}/export Write DICOM onto filesystem #
GET /instances/{id}/file Download DICOM #
GET /instances/{id}/frames List available frames #
GET /instances/{id}/frames/{frame}/image-int16 Decode a frame (int16) #
GET /instances/{id}/frames/{frame}/image-uint16 Decode a frame (uint16) #
GET /instances/{id}/frames/{frame}/image-uint8 Decode a frame (uint8) #
GET /instances/{id}/frames/{frame}/matlab Decode frame for Matlab #
GET /instances/{id}/frames/{frame}/numpy Decode frame for numpy #
GET /instances/{id}/frames/{frame}/preview Decode a frame (preview) #
GET /instances/{id}/frames/{frame}/raw Access raw frame #
GET /instances/{id}/frames/{frame}/raw.gz Access raw frame (compressed) #
GET /instances/{id}/frames/{frame}/rendered Render a frame #
GET /instances/{id}/header Get DICOM meta-header #
GET /instances/{id}/image-int16 Decode an image (int16) #
GET /instances/{id}/image-uint16 Decode an image (uint16) #
GET /instances/{id}/image-uint8 Decode an image (uint8) #
GET /instances/{id}/labels List labels #
DELETE /instances/{id}/labels/{label} Remove label #
GET /instances/{id}/labels/{label} Test label #
PUT /instances/{id}/labels/{label} Add label #
GET /instances/{id}/matlab Decode frame for Matlab #
GET /instances/{id}/metadata List metadata #
DELETE /instances/{id}/metadata/{name} Delete metadata #
GET /instances/{id}/metadata/{name} Get metadata #
PUT /instances/{id}/metadata/{name} Set metadata #
POST /instances/{id}/modify Modify instance #
GET /instances/{id}/module Get instance module #
GET /instances/{id}/numpy Decode instance for numpy #
GET /instances/{id}/patient Get parent patient #
GET /instances/{id}/pdf Get embedded PDF #
GET /instances/{id}/preview Decode an image (preview) #
POST /instances/{id}/reconstruct Reconstruct tags & optionally files of instance #
GET /instances/{id}/rendered Render an image #
GET /instances/{id}/series Get parent series #
GET /instances/{id}/simplified-tags Get human-readable tags #
GET /instances/{id}/statistics Get instance statistics #
GET /instances/{id}/study Get parent study #
GET /instances/{id}/tags Get DICOM tags #

Documentation

📖
APIReference
https://orthanc.uclouvain.be/api/index.html
📖
Documentation
https://orthanc.uclouvain.be/book/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/openapi/uclouvain-instances-api-openapi.yml

Other Resources

🔗
x-openapi-original
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/openapi/_original/uclouvain-orthanc-api.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/examples/uclouvain-orthanc-system-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/uclouvain-instances-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

uclouvain-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'This is the full documentation of the REST API of Orthanc.

    This reference is automatically generated from the source code of Orthanc. A shorter cheat sheet is part of the Orthanc Book.

    An earlier, manually crafted version from August 2019, is still available, but is not up-to-date anymore (source).'
  title: Orthanc Instances API
  version: 1.13.0
servers:
- url: https://orthanc.uclouvain.be/demo/
tags:


# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/openapi/uclouvain-instances-api-openapi.yml