> ## Documentation Index > Fetch the complete documentation index at: https://docs.miramace.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 ## OpenAPI ````yaml POST /v1/task openapi: 3.1.0 info: title: Mira API version: 1.0.0 servers: [] security: [] paths: /v1/task: post: summary: Create a new task description: >- 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 operationId: create_task requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTaskRequest' responses: '201': description: Task created successfully content: application/json: schema: type: object properties: id: type: string format: uuid description: UUID of the created task example: 123e4567-e89b-12d3-a456-426614174002 example: id: 123e4567-e89b-12d3-a456-426614174002 '400': description: Bad request - missing required fields content: application/json: schema: type: object properties: detail: type: string example: Missing required fields '401': description: Unauthorized - Invalid API key content: application/json: schema: type: object properties: detail: type: string example: Invalid API key x-codeSamples: - lang: Python label: Appointment Scheduling source: |- 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()) - lang: Python label: Verify Insurance source: |- import requests url = 'https://api.miramace.com/v1/task' headers = { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } payload = { 'task_type': 'VERIFY_INSURANCE', 'task': 'Verify insurance coverage for MRI', 'phone_number': '+15555555555', 'project_id': 'proj_xyz789', 'patient_id': 'pat_abc123', 'task_data': { 'service': { 'description': 'MRI of right knee', 'cpt_codes': ['73721'] }, 'provider': { 'name': 'Dr. Jane Smith', 'npi': '1234567890', 'specialty': 'Radiology', 'facility': 'SF Medical Imaging', 'address': { 'street_name': '456 Health Ave', 'city': 'San Francisco', 'state': 'CA', 'postal_code': '94105', 'country_code': 'US' }, 'phone_number': '+14155555556' }, 'insurance': { 'company_name': 'Blue Cross Blue Shield', 'member_id': 'BCB123456789', 'group_number': 'GRP987654', 'plan_name': 'PPO Gold', 'phone_number': '+18005551234', 'relationship_to_subscriber': 'SELF', 'primary_subscriber': { 'first_name': 'Jane', 'last_name': 'Doe' } }, 'additional_context': 'Patient may need pre-authorization' } } response = requests.post(url, json=payload, headers=headers) print(response.json()) - lang: Python label: Insurance Reimbursement source: |- import requests url = 'https://api.miramace.com/v1/task' headers = { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } payload = { 'task_type': 'INSURANCE_REIMBURSEMENT', 'task': 'Follow up on reimbursement for ER visit', 'phone_number': '+15555555555', 'project_id': 'proj_xyz789', 'patient_id': 'pat_abc123', 'task_data': { 'case_info': { 'number': 'CASE-12345' }, 'bill': { 'number': 'INV-12345', 'amount': '$1,250.00' }, 'reimbursement_status': 'Pending', 'payment_details': 'Claim #12345 submitted on March 15, 2025', 'treatment_background': 'Emergency room visit for broken arm', 'treatment_data': 'X-ray and cast application', 'primary_insurance': { 'company_name': 'Blue Cross Blue Shield', 'member_id': 'BCB123456789', 'group_number': 'GRP987654', 'plan_name': 'PPO Gold', 'phone_number': '+18005551234', 'relationship_to_subscriber': 'SELF', 'primary_subscriber': { 'first_name': 'Jane', 'last_name': 'Doe' } }, 'provider': { 'name': 'Dr. John Smith', 'npi': '1234567890', 'specialty': 'Emergency Medicine', 'facility': 'City General Hospital', 'address': { 'street_name': '123 Medical Center Dr', 'city': 'San Francisco', 'state': 'CA', 'postal_code': '94105', 'country_code': 'US' }, 'phone_number': '+14155551234' }, 'additional_context': 'Need to reach billing department for invoice question' } } response = requests.post(url, json=payload, headers=headers) print(response.json()) - lang: Python label: Custom Task source: |- import requests url = 'https://api.miramace.com/v1/task' headers = { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } payload = { 'task_type': 'CUSTOM_TASK', 'task': 'Follow up on wheelchair delivery', 'phone_number': '+15555555555', 'project_id': 'proj_xyz789', 'patient_id': 'pat_abc123', 'task_data': { 'additional_context': 'Check if the member has received their recent wheelchair delivery and if they have any questions about it', 'questions_to_ask': [ { 'index': 0, 'question': 'Have you received your wheelchair delivery?', 'answer': 'Yes, I received it last Tuesday' }, { 'index': 1, 'question': 'Is the wheelchair meeting your needs?', 'answer': 'Yes, it's working well for me' } ] } } response = requests.post(url, headers=headers, json=payload) print(response.json()) - lang: JavaScript label: Appointment Scheduling source: |- const response = await fetch('https://api.miramace.com/v1/task', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json', }, body: JSON.stringify({ 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 } }) }); const data = await response.json(); console.log(data); - lang: JavaScript label: Verify Insurance source: |- const response = await fetch('https://api.miramace.com/v1/task', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json', }, body: JSON.stringify({ task_type: 'VERIFY_INSURANCE', task: 'Verify insurance coverage for MRI', phone_number: '+15555555555', project_id: 'proj_xyz789', patient_id: 'pat_abc123', task_data: { service: { description: 'MRI of right knee', cpt_codes: ['73721'] }, provider: { name: 'Dr. Jane Smith', npi: '1234567890', specialty: 'Radiology', facility: 'SF Medical Imaging', address: { street_name: '456 Health Ave', city: 'San Francisco', state: 'CA', postal_code: '94105', country_code: 'US' }, phone_number: '+14155555556' },insurance: { company_name: 'Blue Cross Blue Shield', member_id: 'BCB123456789', group_number: 'GRP987654', plan_name: 'PPO Gold', phone_number: '+18005551234', relationship_to_subscriber: 'SELF',primary_subscriber: { first_name: 'Jane', last_name: 'Doe' } },additional_context: 'Patient may need pre-authorization' } }) }); const data = await response.json(); console.log(data); - lang: JavaScript label: Insurance Reimbursement source: |- const response = await fetch('https://api.miramace.com/v1/task', { method: 'POST',"phone_number": "+15555555555","project_id": "proj_xyz789","patient_id": "pat_abc123","task_data": {"case_info": {"number": "CASE-12345"},"bill": {"number": "INV-12345","amount": "$1,250.00"},"reimbursement_status": "Pending","payment_details": "Claim #12345 submitted on March 15, 2025","treatment_background": "Emergency room visit for broken arm","treatment_data": "X-ray and cast application","primary_insurance": {"company_name": "Blue Cross Blue Shield","member_id": "BCB123456789","group_number": "GRP987654","plan_name": "PPO Gold","phone_number": "+18005551234","relationship_to_subscriber": "SELF","primary_subscriber": {"first_name": "Jane","last_name": "Doe"}},"provider": {"name": "Dr. John Smith","npi": "1234567890","specialty": "Emergency Medicine","facility": "City General Hospital","address": {"street_name": "123 Medical Center Dr","city": "San Francisco","state": "CA","postal_code": "94105","country_code": "US"},"phone_number": "+14155551234"},"additional_context": "Need to reach billing department for invoice question"}}) }); const data = await response.json(); console.log(data); - lang: cURL label: Appointment Scheduling source: |- curl --request POST \ --url https://api.miramace.com/v1/task \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "task_type": "SCHEDULE_APPOINTMENT", "task": "Schedule a follow-up appointment with Dr. Smith for next week", "phone_number": "+15555555555","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}}' - lang: cURL label: Verify Insurance source: |- curl --request POST \ --url https://api.miramace.com/v1/task \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "task_type": "VERIFY_INSURANCE","task": "Verify insurance coverage for MRI","phone_number": "+15555555555","project_id": "proj_xyz789","patient_id": "pat_abc123","task_data": {"service": {"description": "MRI of right knee","cpt_codes": ["73721"]},"provider": {"name": "Dr. Jane Smith","npi": "1234567890","specialty": "Radiology","facility": "SF Medical Imaging","address": {"street_name": "456 Health Ave","city": "San Francisco","state": "CA","postal_code": "94105","country_code": "US"},"phone_number": "+14155555556"},"insurance": {"company_name": "Blue Cross Blue Shield","member_id": "BCB123456789","group_number": "GRP987654","plan_name": "PPO Gold","phone_number": "+18005551234","relationship_to_subscriber": "SELF","primary_subscriber": {"first_name": "Jane","last_name": "Doe"}},"additional_context": "Patient may need pre-authorization"}}' - lang: cURL source: |- curl --request POST \ --url https://api.miramace.com/v1/task \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "task_type": "INSURANCE_REIMBURSEMENT","phone_number": "+15555555555","project_id": "proj_xyz789","patient_id": "pat_abc123","task_data": {"case_info": { "number": "CASE-12345"},"bill": { "number": "INV-12345","amount": "$1,250.00"},"reimbursement_status": "Pending","payment_details": "Claim #12345 submitted on March 15, 2025","treatment_background": "Emergency room visit for broken arm","treatment_data": "X-ray and cast application","primary_insurance": { "company_name": "Blue Cross Blue Shield","member_id": "BCB123456789","group_number": "GRP987654","plan_name": "PPO Gold","phone_number": "+18005551234","relationship_to_subscriber": "SELF","primary_subscriber": { "first_name": "Jane","last_name": "Doe"}},"provider": { "name": "Dr. John Smith","npi": "1234567890","specialty": "Emergency Medicine","facility": "City General Hospital","address": { "street_name": "123 Medical Center Dr","city": "San Francisco","state": "CA","postal_code": "94105","country_code": "US"},"phone_number": "+14155551234"},"additional_context": "Need to reach billing department for invoice question"}}' - lang: cURL source: |- curl --request POST \ --url https://api.miramace.com/v1/task \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "task_type": "CUSTOM_TASK","phone_number": "+15555555555","project_id": "proj_xyz789","patient_id": "pat_abc123","task_data": {"additional_context": "Check if the member has received their recent wheelchair delivery and if they have any questions about it","questions_to_ask": [ { "index": 0, "question": "Have you received your wheelchair delivery?", "answer": "Yes, I received it last Tuesday" }, { "index": 1, "question": "Is the wheelchair meeting your needs?", "answer": "Yes, it's working well for me" } ] }}' components: schemas: CreateTaskRequest: type: object required: - task_type - task - phone_number - project_id - patient_id properties: task_type: $ref: '#/components/schemas/TaskType' task: type: string description: Main task description with sufficient detail for the voice agent example: Schedule a follow-up appointment with Dr. Smith for next week phone_number: $ref: '#/components/schemas/PhoneNumber' project_id: type: string format: uuid description: UUID of the project this task belongs to example: 123e4567-e89b-12d3-a456-426614174000 patient_id: type: string format: uuid description: UUID of the patient that this task is about example: 123e4567-e89b-12d3-a456-426614174001 task_data: oneOf: - type: object title: Schedule Appointment Data description: Data specific to scheduling appointments properties: timeframe_availability: type: string description: Timeframe availability for the appointment speciality_preferences: type: string description: Speciality preferences for the appointment additional_context: type: string description: Additional context for the appointment previous_visits: type: array items: $ref: '#/components/schemas/Visit' patient_status: type: string description: Status of the patient (new or existing) has_referral: type: boolean description: Whether the patient has a referral referral: $ref: '#/components/schemas/Provider' is_rescheduling: type: boolean description: Whether this is a rescheduling existing_appointment: type: string description: Details of the existing appointment (for rescheduling) reschedule_reason: type: string description: Reason for rescheduling - type: object title: Verify Insurance Data description: Data specific to insurance verification properties: service: $ref: '#/components/schemas/Service' provider: $ref: '#/components/schemas/Provider' insurance: $ref: '#/components/schemas/MemberInsurance' additional_context: type: string description: Additional context for the insurance verification example: Patient may need pre-authorization - type: object title: Reimbursement Data description: Data specific to insurance reimbursement properties: case_info: type: object properties: number: type: string description: The number of the case example: CASE-12345 created_at: type: string format: date description: A date in ISO 8601 format (YYYY-MM-DD) example: '2025-03-15' bill: type: object properties: number: type: string description: The number of the bill example: INV-12345 amount: type: string description: The amount of the bill example: $1,250.00 phone_number: type: string description: >- The phone number to call in E.164 format (e.g., +15555555555) pattern: ^\+[1-9]\d{1,14}$ example: '+15555555555' address: type: object properties: street: type: string description: The street address (including unit) example: 123 Main St, Apt 4B city: type: string description: The city example: San Francisco state: type: string description: The state example: CA zip_code: type: string description: The ZIP code example: '94105' country: type: string description: The country example: USA reimbursement_status: type: string description: The reimbursement status example: Pending payment_details: type: string description: The payment details example: 'Claim #12345 submitted on March 15, 2025' treatment_background: type: string description: The treatment background example: Emergency room visit for broken arm treatment_data: type: string description: The treatment data example: X-ray and cast application primary_insurance: $ref: '#/components/schemas/MemberInsurance' secondary_insurance: $ref: '#/components/schemas/MemberInsurance' provider: $ref: '#/components/schemas/Provider' additional_context: type: string description: Additional context for the reimbursement example: Need to reach billing department for invoice question - type: object title: Custom Task Data description: Data specific to custom tasks properties: additional_context: type: string description: Additional context for custom task example: >- Check if the member has received their recent wheelchair delivery and if they have any questions about it questions_to_ask: type: array description: >- List of questions that the agent should ask during the custom task call items: type: object properties: index: type: integer description: The order in which the question should be asked minimum: 0 example: 0 question: type: string description: The question to ask example: Have you received your wheelchair delivery? answer: type: string description: A reasonable answer to the question example: Yes, I received it last Tuesday required: - index - question discriminator: propertyName: task_type mapping: SCHEDULE_APPOINTMENT: '#/components/schemas/ScheduleAppointmentData' VERIFY_INSURANCE: '#/components/schemas/VerifyInsuranceData' REIMBURSEMENT: '#/components/schemas/ReimbursementData' CUSTOM_TASK: '#/components/schemas/CustomTaskData' TaskType: type: string enum: - SCHEDULE_APPOINTMENT - VERIFY_INSURANCE - REIMBURSEMENT - CUSTOM_TASK description: |- The type of task to be executed. Note: tasks need to be enabled at the project level PhoneNumber: type: string description: The phone number in E.164 format (e.g., +15555555555) pattern: ^\+[1-9]\d{1,14}$ example: '+15555555555' Visit: type: object properties: purpose: type: string description: The purpose of the visit example: Initial consultation date: $ref: '#/components/schemas/Date' outcome: type: string description: The outcome of the visit example: Referred to specialist Provider: type: object properties: name: type: string description: Name of the provider example: Dr. Jane Smith npi: type: string description: National Provider Identifier example: '1234567890' specialty: type: string description: Provider's specialty example: Orthopedic Surgery facility: type: string description: Healthcare facility name example: Bay Area Orthopedics address: $ref: '#/components/schemas/Address' phone_number: $ref: '#/components/schemas/PhoneNumber' Service: type: object properties: description: type: string description: Description of the medical service example: MRI of right knee cpt_codes: type: array items: type: string description: List of CPT codes for the service example: - '73721' MemberInsurance: type: object properties: company_name: type: string description: The name of the insurance company example: Blue Cross Blue Shield member_id: type: string description: The member ID example: XYZ1234567 group_number: type: string description: The group number example: GRP123456 plan_name: type: string description: The plan name example: PPO Gold phone_number: $ref: '#/components/schemas/PhoneNumber' nullable: true relationship_to_subscriber: $ref: '#/components/schemas/RelationshipToSubscriber' primary_subscriber: $ref: '#/components/schemas/PrimarySubscriber' Date: type: string format: date description: Date in ISO 8601 format (YYYY-MM-DD) example: '1990-01-01' Address: type: object required: - street_name - city - state - postal_code - country_code properties: street_name: type: string description: Street address example: 123 Main St city: type: string description: City example: San Francisco state: type: string description: State/province example: CA postal_code: type: string description: Postal/ZIP code example: '94105' country_code: type: string description: Two-letter country code example: US RelationshipToSubscriber: type: string enum: - RELATIONSHIP_TO_SUBSCRIBER_UNSPECIFIED - SELF - SPOUSE - DEPENDENT description: The relationship of the member to the primary subscriber example: SELF PrimarySubscriber: type: object properties: first_name: type: string description: The first name of the primary subscriber example: John last_name: type: string description: The last name of the primary subscriber example: Doe ````