Skip to main content

Blair API Documentation

Welcome to the Blair API documentation. This comprehensive guide provides everything you need to integrate with our healthcare AI platform.

Base URLs​

All API endpoints are accessed through:

  • Production: https://orchestrator.helloblair.com
  • Sandbox: https://sandbox-ec2.helloblair.com

Quick Start​

  1. Get your API Key: Contact your administrator to obtain an API key for your organization.

  2. Authenticate: Include your API key in all requests:

    X-API-Key: YOUR_API_KEY

  3. Make your first call: Create an outbound call:

    curl -X POST https://orchestrator.helloblair.com/api/v1/calls \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "patients": [{
          "patientId": "YOUR_PATIENT_ID"
        }],
        "agentId": "YOUR_AGENT_ID",
        "recording": true
      }'

Core Features​

📞 Calls Management​

  • Create single or batch outbound calls
  • Monitor call status in real-time
  • Terminate active calls
  • Access call recordings and transcripts

🤖 Agent Management​

  • Update knowledge bases in real-time
  • Customize agent instructions up to 20,000 characters

👥 Patient Management​

  • Create and manage patient records
  • Store contact information and metadata
  • HIPAA-compliant data handling
  • Bulk patient operations

API Sections​

Explore each section of the API:

  • Authentication - Learn how to authenticate your API requests
  • Calls - Manage outbound phone calls
  • Agents - Manage AI agent configurations
  • Patients - Manage patient records
  • Cases - Retrieve case information
  • Common Topics - Error handling, pagination, and best practices

Response Format​

All successful API responses follow this structure:

{
  "success": true,
  "data": { ... },
  "message": "Optional success message"
}

Error responses include:

{
  "success": false,
  "error": {
    "status": 400,
    "message": "Detailed error description",
    "timestamp": "2024-01-15T10:30:00.000+00:00",
    "requestId": "req_1234567890_abc123",
    "path": "/api/v1/calls",
    "method": "POST"
  }
}

Support​

For API support or questions:

  • Review the error messages and status codes
  • Check the Common Topics section for troubleshooting
  • Contact support for API key issues