SOPwise AI Plugin API Documentation

Overview

SOPwise AI is a specialized medical assistant API that processes and analyzes Standard Operating Procedures (SOPs) documents. It helps healthcare professionals find specific medical information like drug dosages, treatment protocols, and procedural guidelines.

Base URL: https://app.sopwise.ai

Current Version: v1

Authentication

All API endpoints require Bearer token authentication:

Authorization: Bearer YOUR_API_KEY

Getting an API Key

1. Login to your SOPwise account
2. Navigate to account settings by clicking your email in the sidebar
3. Scroll down to the "API Keys" section
4. Generate a new API key for plugin use

API Endpoints

POST /upload_sop
Content-Type: multipart/form-data
Authorization: Bearer YOUR_API_KEY

files: [file1.pdf, file2.docx]
ocr_mode: "fast"

{
  "reply": "Uploaded 2 document(s) successfully!",
  "suggestions": [
    "What are the dosage recommendations?",
    "What are the contraindications?"
  ]
}

POST /ask
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "message": "What are the dosage recommendations for vancomycin?",
  "stream": false
}

{
  "reply": "Based on the uploaded SOPs, vancomycin dosage recommendations are:\n\n1. Loading dose: 25-30 mg/kg IV\n2. Maintenance dose: 15-20 mg/kg every 8-12 hours\n3. Target trough levels: 15-20 mg/L for serious infections",
  "suggestions": [
    "What are the monitoring requirements?",
    "What are the contraindications?"
  ]
}

{
  "sops": [
    {
      "id": 1,
      "filename": "vancomycin-protocol-2021.pdf",
      "topic": "Antibiotic Protocols",
      "language": "en",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

{
  "topics": [
    "Antibiotic Protocols",
    "Emergency Procedures",
    "ICU Management"
  ]
}

{
  "status": "operational",
  "documents_loaded": 5,
  "available_languages": ["en", "de"]
}

Usage Examples

Python Example

import requests

# Upload documents
files = {'files': open('sop.pdf', 'rb')}
response = requests.post(
    'https://app.sopwise.ai/upload_sop/',
    files=files,
    data={'ocr_mode': 'fast'},
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)

# Ask question
response = requests.post(
    'https://app.sopwise.ai/ask/',
    json={'message': 'What are the dosage recommendations?'},
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)

JavaScript Example

// Upload documents
const formData = new FormData();
formData.append('files', fileInput.files[0]);
formData.append('ocr_mode', 'fast');

const uploadResponse = await fetch('/upload_sop/', {
    method: 'POST',
    body: formData,
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
    }
});

// Ask question
const askResponse = await fetch('/ask/', {
    method: 'POST',
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        message: 'What are the dosage recommendations?'
    })
});

cURL Example

# Upload document
curl -X POST "https://app.sopwise.ai/upload_sop/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "files=@sop.pdf" \
  -F "ocr_mode=fast"

# Ask question
curl -X POST "https://app.sopwise.ai/ask/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "What are the dosage recommendations?"}'

Error Handling

All endpoints return JSON error responses with the following structure:

{
  "error": "Error description",
  "code": "ERROR_CODE"
}

Common HTTP Status Codes

Rate Limiting & Quotas

Support & Resources

• Email: support@sopwise.ai
• Interactive Demo: Try the API Demo
• Status Page: System Status