Upload DICOMs

Learn how to upload your DICOMs with the /studies API.

Related Guides: For X-Rays , For CTs

Overview

You can use the /studies API to upload DICOM images. The API accepts DICOM files for analysis. Ensure that the files adhere to the specified DICOM standards and include all necessary metadata.

Note: You can also use the /upload API to upload DICOMs. The schema, request, and response formats are the same.

API Format

POST /studies

Request Formats

cURL

curl -X POST \\
-L 'Base_URL/studies/' \\
-H 'Content-Type: multipart/form-data' \\
-H 'Authorization: Token <PASTE_YOUR_TOKEN>' \\
-H 'Source: <PASTE_YOUR_SOURCE>' \\
-H 'User-Agent: <YOUR_USER_AGENT>' \\
-F 'file_1=@"</path/to/your/dicom_file1.dcm>"' \\
-F 'file_2=@"</path/to/your/dicom_file2.dcm>"' \\
-F 'file_3=@"</path/to/your/dicom_file3.dcm>"'

Python

import requests

url = "Base_URL/studies/"

# Prepare the files for upload. Assign each file a unique key.
files = {
    'file_0': ('<dicom_file1.dcm>', open('<path/to/dicom_file1.dcm>', 'rb'), 'application/dicom'),
    'file_1': ('<dicom_file2.dcm>', open('<path/to/dicom_file2.dcm>', 'rb'), 'application/dicom'),
    'file_2': ('<dicom_file3.dcm>', open('<path/to/dicom_file3.dcm>', 'rb'), 'application/dicom')
}

# Headers, including the Authorization token and Source
headers = {
    'Authorization': 'Token <PASTE_YOUR_TOKEN>',
    'Source': '<PASTE_YOUR_SOURCE>',
    'Content-Type': 'multipart/form-data',
    'User-Agent': '<YOUR_USER_AGENT>'
}

# Perform the POST request
response = requests.post(url, headers=headers, files=files)

# Print the response text
print(response.text)

# Close the file handles after the request is done
for file in files.values():
    file[1].close()

Upload DICOMs.

POSTBASE_URL/studies

Body

multipart/form-data

Contains the DICOMs to be uploaded.

file0string (binary)

The first DICOM file to be uploaded.

file1string (binary)

The second DICOM file to be uploaded.

file2string (binary)

The third DICOM file to be uploaded.

Response

200400401

DICOMS uploaded successfully

Body

application/json

messagestring

A message that validates the upload request based on the response status code.

Example: "Success"

statusstring

Example: "success"

messagesobject

Contains information about the uploaded files along with their metadata.

series_instance_uidsarray of string

A list of SeriesInstanceUIDs present in the uploaded files.

detailed_infoarray of object

An object that contains detailed information about the uploaded DICOMs.

Request

cURLPython

curl -X POST \\
-L 'Base_URL/studies/' \\
-H 'Content-Type: multipart/form-data' \\
-H 'Authorization: Token <PASTE_YOUR_TOKEN>' \\
-H 'Source: <PASTE_YOUR_SOURCE>' \\
-F 'file_1=@"</path/to/your/dicom_file1.dcm>"' \\
-F 'file_2=@"</path/to/your/dicom_file2.dcm>"' \\
-F 'file_3=@"</path/to/your/dicom_file3.dcm>"'

Response

200400401

{
  "message": "Success",
  "status": "success",
  "messages": {
    "file0": {
      "message": "DICOM registered successfully.",
      "created": false,
      "license_expired": false
    },
    "file1": {
      "message": "DICOM registered successfully.",
      "created": false,
      "license_expired": false
    },
    "file2": {
      "message": "DICOM registered successfully.",
      "created": false,
      "license_expired": false
    }
  },
  "series_instance_uids": [
    "text"
  ],
  "detailed_info": [
    {
      "SeriesInstanceUID": "text",
      "NumberOfSeriesRelatedInstances": 0
    }
  ]
}