Make Your First API Request

Let’s learn how to make requests to the Platform APIs with the help of an example. You can paste the command below into your terminal to run your first API request. Make sure to replace placeholders for Base URL, Token, Source, and path to your DICOM file with your actual data.

Request Format

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()

When you make a request to the Platform APIs, the response includes two key components

1. HTTP Status Code: The HTTP status codes for all responses follow the RFC 9110 standard.

2. JSON Body: The JSON body contains detailed information about the response.

You can find specific information about the response format for each API, in the subsequent sections.