import requests

url = 'https://api.miramace.com/v1/task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
payload = {
    'task_type': 'SCHEDULE_APPOINTMENT',
    'task': 'Schedule a follow-up appointment with Dr. Smith for next week',
    'phone_number': '+15555555555',
    'project_id': '123e4567-e89b-12d3-a456-426614174000',
    'patient_id': '123e4567-e89b-12d3-a456-426614174001',
    'task_data': {
        'timeframe_availability': 'Weekdays between 2-5pm',
        'speciality_preferences': 'Orthopedic surgeon, preferably Dr. Smith',
        'additional_context': 'Patient prefers afternoon appointments',
        'previous_visits': [{
            'purpose': 'Initial consultation for knee pain',
            'date': '2024-03-15',
            'outcome': 'Recommended physical therapy and follow-up'
        }],
        'patient_status': 'existing',
        'has_referral': true,
        'referral': {
            'name': 'Dr. Robert Johnson',
            'npi': '0987654321',
            'specialty': 'Primary Care',
            'facility': 'SF Medical Group',
            'address': {
                'street_name': '456 Health Ave',
                'city': 'San Francisco',
                'state': 'CA',
                'postal_code': '94105',
                'country_code': 'US'
            },
            'phone_number': '+14155555556'
        },
        'is_rescheduling': false,
        'existing_appointment': null,
        'reschedule_reason': null
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174002"
}

Tasks

Create Task

Create a new task to be processed by the Mira platform.

We offer these task types out of the box:

• Appointment Scheduling: Schedule or reschedule medical appointments with preferred providers and timing.

• Insurance Verification: Check insurance coverage, benefits, and pre-authorization requirements.

• Insurance Reimbursement: Process and track insurance reimbursement claims.

• Custom Healthcare Tasks: Execute flexible, healthcare-related tasks with configurable workflows.

Need a custom task type for your specific workflow? We can spin one for you quickly, contact us

POST

task

import requests

url = 'https://api.miramace.com/v1/task'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
payload = {
    'task_type': 'SCHEDULE_APPOINTMENT',
    'task': 'Schedule a follow-up appointment with Dr. Smith for next week',
    'phone_number': '+15555555555',
    'project_id': '123e4567-e89b-12d3-a456-426614174000',
    'patient_id': '123e4567-e89b-12d3-a456-426614174001',
    'task_data': {
        'timeframe_availability': 'Weekdays between 2-5pm',
        'speciality_preferences': 'Orthopedic surgeon, preferably Dr. Smith',
        'additional_context': 'Patient prefers afternoon appointments',
        'previous_visits': [{
            'purpose': 'Initial consultation for knee pain',
            'date': '2024-03-15',
            'outcome': 'Recommended physical therapy and follow-up'
        }],
        'patient_status': 'existing',
        'has_referral': true,
        'referral': {
            'name': 'Dr. Robert Johnson',
            'npi': '0987654321',
            'specialty': 'Primary Care',
            'facility': 'SF Medical Group',
            'address': {
                'street_name': '456 Health Ave',
                'city': 'San Francisco',
                'state': 'CA',
                'postal_code': '94105',
                'country_code': 'US'
            },
            'phone_number': '+14155555556'
        },
        'is_rescheduling': false,
        'existing_appointment': null,
        'reschedule_reason': null
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174002"
}

Body

application/json

task_type

enum<string>

required

The type of task to be executed.

Note: tasks need to be enabled at the project level

Available options:

SCHEDULE_APPOINTMENT,

VERIFY_INSURANCE,

REIMBURSEMENT,

CUSTOM_TASK

task

string

required

Main task description with sufficient detail for the voice agent

Example:

"Schedule a follow-up appointment with Dr. Smith for next week"

phone_number

string

required

The phone number in E.164 format (e.g., +15555555555)

Example:

"+15555555555"

project_id

string<uuid>

required

UUID of the project this task belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

patient_id

string<uuid>

required

UUID of the patient that this task is about

Example:

"123e4567-e89b-12d3-a456-426614174001"

task_data

Schedule Appointment Data · object

Data specific to scheduling appointments

Schedule Appointment Data
Verify Insurance Data
Reimbursement Data
Custom Task Data

Show child attributes

task_data.timeframe_availability

string

Timeframe availability for the appointment

task_data.speciality_preferences

string

Speciality preferences for the appointment

task_data.additional_context

string

Additional context for the appointment

task_data.previous_visits

object[]

Show child attributes

task_data.previous_visits.purpose

string

The purpose of the visit

Example:

"Initial consultation"

task_data.previous_visits.date

string<date>

Date in ISO 8601 format (YYYY-MM-DD)

Example:

"1990-01-01"

task_data.previous_visits.outcome

string

The outcome of the visit

Example:

"Referred to specialist"

task_data.patient_status

string

Status of the patient (new or existing)

task_data.has_referral

boolean

Whether the patient has a referral

task_data.referral

object

Show child attributes

task_data.referral.name

string

Name of the provider

Example:

"Dr. Jane Smith"

task_data.referral.npi

string

National Provider Identifier

Example:

"1234567890"

task_data.referral.specialty

string

Provider's specialty

Example:

"Orthopedic Surgery"

task_data.referral.facility

string

Healthcare facility name

Example:

"Bay Area Orthopedics"

task_data.referral.address

object

Show child attributes

task_data.referral.address.street_name

string

required

Street address

Example:

"123 Main St"

task_data.referral.address.city

string

required

City

Example:

"San Francisco"

task_data.referral.address.state

string

required

State/province

Example:

"CA"

task_data.referral.address.postal_code

string

required

Postal/ZIP code

Example:

"94105"

task_data.referral.address.country_code

string

required

Two-letter country code

Example:

"US"

task_data.referral.phone_number

string

The phone number in E.164 format (e.g., +15555555555)

Example:

"+15555555555"

task_data.is_rescheduling

boolean

Whether this is a rescheduling

task_data.existing_appointment

string

Details of the existing appointment (for rescheduling)

task_data.reschedule_reason

string

Reason for rescheduling

Response

Task created successfully

string<uuid>

UUID of the created task

Example:

"123e4567-e89b-12d3-a456-426614174002"

Get Patient Details Get Task Progress

⌘I

API Documentation

Patients

Tasks

Create Task

Body

Response