POST
/
alpha
/
note-templates
curl -X POST "https://api.sully.ai/alpha/note-templates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "notes": [
      {
        "content": "Chief Complaint: Patient presents with chest pain.\n\nHistory of Present Illness: 45-year-old male with acute onset chest pain, radiating to left arm. Pain started 2 hours ago while at rest.\n\nPhysical Exam: Vital signs stable. Heart rate 88 bpm, BP 140/90.\n\nAssessment: Possible acute coronary syndrome.\n\nPlan: ECG, troponin levels, cardiology consult.",
        "description": "Cardiology consultation note"
      },
      {
        "content": "Chief Complaint: Shortness of breath.\n\nHistory of Present Illness: 67-year-old female with progressive dyspnea over 3 days. No chest pain.\n\nPhysical Exam: Crackles bilateral lower lobes. JVD present.\n\nAssessment: Congestive heart failure exacerbation.\n\nPlan: Chest X-ray, BNP, diuretics, follow-up in 48 hours.",
        "description": "Heart failure follow-up"
      }
    ],
    "instructions": "Focus on creating a template for cardiology consultations with emphasis on systematic assessment."
  }'
{
  "data": {
    "id": "template_abc123def456",
    "status": "pending",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Overview

The note template generation endpoint analyzes your provider notes to automatically create customized note templates. This helps standardize documentation while preserving your unique clinical style and preferred structure.

Request Body

notes
array
required
Array of provider notes to analyze (minimum 1, maximum 5 notes per request)
instructions
string
Optional instructions for the template generation process

Response

data
object
The created note template generation job
curl -X POST "https://api.sully.ai/alpha/note-templates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "notes": [
      {
        "content": "Chief Complaint: Patient presents with chest pain.\n\nHistory of Present Illness: 45-year-old male with acute onset chest pain, radiating to left arm. Pain started 2 hours ago while at rest.\n\nPhysical Exam: Vital signs stable. Heart rate 88 bpm, BP 140/90.\n\nAssessment: Possible acute coronary syndrome.\n\nPlan: ECG, troponin levels, cardiology consult.",
        "description": "Cardiology consultation note"
      },
      {
        "content": "Chief Complaint: Shortness of breath.\n\nHistory of Present Illness: 67-year-old female with progressive dyspnea over 3 days. No chest pain.\n\nPhysical Exam: Crackles bilateral lower lobes. JVD present.\n\nAssessment: Congestive heart failure exacerbation.\n\nPlan: Chest X-ray, BNP, diuretics, follow-up in 48 hours.",
        "description": "Heart failure follow-up"
      }
    ],
    "instructions": "Focus on creating a template for cardiology consultations with emphasis on systematic assessment."
  }'
{
  "data": {
    "id": "template_abc123def456",
    "status": "pending",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Status Codes

202
Accepted
Note template generation job created successfully and is being processed
400
Bad Request
Invalid request body, missing required fields, or validation errors
  • Missing notes array
  • Too many notes (maximum 5)
  • Empty note content
  • Description too long (maximum 1000 characters)
401
Unauthorized
Invalid or missing API key
500
Internal Server Error
Server error occurred while processing the request

Validation Rules

Input Validation: The following validation rules apply:
  • Notes: Minimum 1, maximum 5 notes per request
  • Content: Required for each note, cannot be empty
  • Description: Optional, maximum 1000 characters
  • Instructions: Optional, no length limit

Next Steps

After creating a note template generation job:
  1. Poll for results: Use the Get Note Template endpoint with the returned ID to check status and retrieve results
  2. Use webhooks: Configure webhooks to get notified when processing completes (recommended)
  3. Clean up: Use the Delete Note Template endpoint to remove jobs you no longer need

Best Practices

Note Selection

  • Quality over quantity: Use your best, most representative notes
  • Consistency: Include notes with similar structure and style
  • Completeness: Use complete notes rather than fragments
  • Variety: Include different types of cases within the same specialty

Instructions

  • Be specific: “Focus on cardiology consultations” vs. “Make a good template”
  • Mention priorities: “Emphasize differential diagnosis section”
  • Include preferences: “Use bullet points for assessment and plan”

Example Instructions

{
  "instructions": "Create a template for emergency department visits focusing on rapid assessment. Prioritize chief complaint, vital signs, and disposition. Use concise bullet points for efficiency."
}