MaxYield Quick-Start Guide

ECG Signal Processing & Data Integration Platform
Version: v1.0 | Updated: April 2025
Contact: ask@theneuralcloud.com

‍

To create a NeuralCloud Solutions account:

• Visit: https://app.theneuralcloud.com
• Click "Not a member? Sign Up"

• Enter the following details:
  
  • Email
  • Full Name
  • Password (minimum 8 characters)
  • Full Name
  • Agree to Terms of Service and Privacy Policy

• Check your email for a confirmation link from hello@theneuralcloud.com and click it. Please check any junk or spam folders. 

• After confirming, once selected, you will be brought to https://app.theneuralcloud.com/users/sign_in and will see a pop-up confirmation. 
• Continue to Sign in using your newly created login credentials.

Set Up Billing

• Log in to your account at https://app.theneuralcloud.com
• Navigate to the "Billing" section on the left-hand menu.
• Select your preferred plan.
• Enter your payment details.
• Click "Start Trial".
• You will see a confirmation message upon successful subscription.

Get Your API Key

• Go to your main dashboard within the platform.
• Click "API Key" on the side Menu 
• Click “Create API Key”
• Copy the key immediately; it will only be shown once.
• Store the API key securely, as it will be used to authorize all API requests.

Upload Your First EDF File: MaxYield REST API Script

Tutorials on how to use the REST API with Python can be found on our GitHub repository: https://github.com/NeuralCloudSolutions/ecg-tutorials. 

Since this is a REST API, you are not required to use Python and can use any programming language as long as it supports HTTPS requests.

• Endpoints
  
  • File create (POST): Creates an API File; Returns an upload URL.
  • File confirm (POST): Confirms a file has been uploaded.
  • ECG Analysis (POST): Creates a job to analyze an EDF file (API File).‍
  • ECG Job Status (GET): Checks the status of a submitted job.‍
    

Upload EDF files to the MaxYield platform for analysis

POST https://api.theneuralcloud.com/api/v1/files

• Send a request to this endpoint to create an API File with an ID. The API File will be in a ‘pending’ status until a file is uploaded and confirmed.
• The response will specify an upload URL, headers, and a confirmation URL.
• Send a PUT request to the upload URL with the specified headers and the EDF file as the request's body.
• Send an authorized POST request to the confirmation URL using your API key (same authorization header as shown below). If the file has been successfully uploaded, the API File status will be changed to ‘confirmed’.
• The API File ID can now be referenced when creating a job.

• Headers
  
  • Authorization: Bearer {{API_KEY}}
• Body Form Parameters:
  
  • byte_size: The number of bytes in the file.
  • md5sum: The MD5 checksum of the file.‍

Example:

curl -X POST --location 'https://api.theneuralcloud.com/api/v1/files’ \
--header 'Authorization: Bearer {{API_KEY}}' \
--form 'byte_size=125952' \
--form 'md5sum="6f5902ac237024bdd0c176cb93063dc4"'

Example Output:

{
    "file": {
        "id": 123,
        "status": "pending",
        "upload": {
            "url": "https://...",
            "headers": {
                "HEADER1": "VALUE1",
                "HEADER2": "VALUE2"
            },
            "confirmation_url": "https://https://api.theneuralcloud.com/api/v1/files/123/confirm"
        }
    }
}

Example upload request:

curl -X PUT --location 'https://…’ \
--header 'HEADER1: VALUE1' \
--header 'HEADER2: VALUE2' \
-T “file.edf”

Example confirmation request:

curl -X POST --location 'https://api.theneuralcloud.com/api/v1/files/123/confirm’ \
--header 'Authorization: Bearer {{API_KEY}}’

Start ECG analysis on the MaxYield platform, given a previously uploaded file.

This will create a job to process an EDF file.

POST https://api.theneuralcloud.com/api/v1/ecg_wave_analysis

• Headers
  
  • Authorization: Bearer {{API_KEY}}
• Body Form Parameters:
  
  • file_id: The API File ID specifying the file to be processed.
    
  • Leads[]: A lead to be processed. All leads are analyzed if this parameter is not set.

Example:

curl -X POST --location 'https://api.theneuralcloud.com/api/v1/ecg_wave_analysis' \
--header 'Authorization: Bearer {{API_KEY}}' \
--form 'file_id=123' \
--form 'leads[]="0"' \
--form 'leads[]="1"'

Example Output:

{
    "job": {
        "id": 0,
        "type": "ecg_wave_analysis",
        "status": "queued",
        "credits": 1,
        "received_at": "2025-02-26T19:46:27.787Z",
        "completed_at": null,
        "options": {
            "leads": [
                0,
                1
            ]
        },
        "error": null,
        "result": null,
        "output_files": []
    }
}

Check the status of the given job.

Once the job is complete, you can download the files using the links found in the output files section of the JSON response. Longer jobs will take a few minutes to complete.

GET https://api.theneuralcloud.com/api/v1/jobs/{{job_id}} 

• Headers
  
  • Authorization: Bearer {{API_KEY}}

Example:

curl --location 'https://api.theneuralcloud.com/api/v1/jobs/{{job_id}}’ \
--header 'Authorization: Bearer {{API_KEY}}'


Example Output:

{
    "job": {
        "id": 0,
        "type": "ecg_wave_analysis",
        "status": "completed",
        "credits": 1,
        "received_at": "2025-02-26T19:46:27.787Z",
        "completed_at": "2025-02-26T19:46:29.316Z",
        "options": {
            "leads": [
                0,
                1
            ]
        },
        "error": "",
        "result": {},
        "output_files": [
            {
                "filename": "ecg.edf",
                "url": "https://…"
            },
            {
                "filename": "pqrst.csv",
                "url": "https://…"
            },
            {
                "filename": "intervals.csv",
                "url": "https://…"
            }
        ]
    }
}

‍

Errors

All JSON responses have a ‘status’ field that will tell you the state of the job. If a job fails, it will be marked with an ‘error’ and an error message will be visible in the ‘error’ field of the JSON.

Key Security Practices

• Always use HTTPS when making API requests.
• Do not share or hardcode your API keys.
• Only upload de-identified EDF files to the platform (patient information removed from the EDF header).
• Output files are available for download for 30 days upon job completion and then automatically deleted for privacy protection.

Sandbox & Environments

• Use different API keys or create separate workspaces for development, testing, and production.
• Data is scoped to each workspace, ensuring separation and access control.

API Usage Policy

• API access is governed by a credit-based usage system.
• Recommended maximum job submissions:
  
  • Up to 5 large EDF files per hour (≥ 24-hour recordings)
  • Up to 20 small EDF files per hour (< 24-hour recordings)
• Contact support if you anticipate higher volumes.

Help & Support

• Tutorials and example scripts: https://github.com/NeuralCloudSolutions/ecg-tutorials 
• Documentation and privacy policy: https://www.theneuralcloud.com 
• For technical support: email support@theneuralcloud.com