API Reference

Complete API documentation for OptiMediX integration

POST/api/v1/analysis/pneumonia

Analyze chest X-ray for pneumonia detection

Parameters

imagefilerequired

Chest X-ray image (JPEG, PNG, DICOM)

patient_idstringrequired

Unique patient identifier

Example Request

curl -X POST "https://api.optimedix.ai/v1/analysis/pneumonia" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: multipart/form-data" \
-F "image=@chest_xray.jpg" \
-F "patient_id=P12345"

Responses

200

Successful analysis

{
  "prediction": "pneumonia",
  "confidence": 0.95,
  "regions_of_interest": [
    {
      "x": 120,
      "y": 150,
      "width": 100,
      "height": 100
    }
  ],
  "processing_time": "1.2s"
}
400

Invalid input

{
  "error": "Invalid image format"
}
Rate Limit: 100 requests per minute
GET/api/v1/patients/{id}

Retrieve patient information and medical history

Parameters

idstringrequired

Patient's unique identifier

Example Request

curl -X GET "https://api.optimedix.ai/v1/patients/P12345" \
-H "Authorization: Bearer YOUR_API_KEY"

Responses

200

Patient data retrieved successfully

{
  "id": "P12345",
  "name": "John Doe",
  "medical_history": [],
  "recent_analyses": []
}
404

Patient not found

{
  "error": "Patient not found"
}
Rate Limit: 1000 requests per hour
GET/api/v1/patients/{patient_id}/history

Retrieve patient's analysis history

Parameters

patient_idstringrequired

Unique patient identifier

from_datestring

Filter results from this date (YYYY-MM-DD)

Example Request

curl "https://api.optimedix.ai/v1/patients/P12345/history" \
-H "Authorization: Bearer YOUR_API_KEY"

Responses

200

Successfully retrieved history

{
  "patient_id": "P12345",
  "analyses": [
    {
      "id": "A789",
      "type": "pneumonia_detection",
      "result": "positive",
      "confidence": 0.95,
      "date": "2024-03-15T14:30:00Z"
    }
  ]
}
Rate Limit: 1000 requests per hour

SDK Examples

import optimedix

client = optimedix.Client('YOUR_API_KEY')

# Analyze an image
response = client.analysis.detect_pneumonia(
    image_path='chest_xray.jpg',
    patient_id='P12345'
)