Cortex API
Search…
Getting Started
Connecting to the Cortex API
Overview of API flow
Authentication
Headsets
Sessions
Data Subscription
Records
Markers
Subjects
BCI
Advanced BCI
Warning Objects
Error Codes
Release Notes
cortexaccess tool
Powered By GitBook
Release Notes

Cortex 3.2 - January 2022

Cortex 3.1.3 - December 2021

  • Support macOS 12.1

Cortex 3.1.1, 3.1.2 - December 2021

  • Bug fixes on some instances where the database cannot be initialised properly

Cortex 3.1 - December 2021

Cortex 3.0.1 - November 2021

  • No change in the Cortex API
  • Bug fixes, make the Bluetooth connection more stable

Cortex 3.0 - October 2021

Cortex 2.7.3 - August 2021

  • Fixed the scaled value from Interest / Valance that may go out of range in some cases.
  • Fixed Focus / Stress performance metrics with EPOC X.

Cortex 2.7.2 - July 2021

  • No change in the Cortex API

Cortex 2.7.1 - May 2021

  • It is now possible to run all the detections with an EPOC Flex headset. This requires a specific EEG sensor mapping. See Data Subscription for details.
  • Cortex is now available for Raspberry Pi OS
Check the Getting Started page to see all the supported headsets and platforms.

Cortex 2.7.0 - April 2021

  • New data stream "eq" to get the EEG quality. See Data sample object. Please read this page to understand the difference between the contact quality and the EEG quality.
  • New label "BatteryPercent" added to the "dev" data stream. See Data sample object.
  • The method exportRecord is now available on iOS and Android

Cortex 2.6.4 - March 2021

  • Bug fixes
  • No change in the Cortex API

Cortex 2.6.3 - January 2021

  • New parameters added to the method exportRecord​
  • New parameters added to the method queryRecords​
  • Cortex is now available for Linux Ubuntu (Beta release)
Check the Getting Started page to see all the supported headsets and platforms.

Cortex 2.6.2 - December 2020

  • Solve an issue on macOS 11, where EMOTIV headsets couldn't connect by Bluetooth.
  • No change in the Cortex API

Cortex 2.6.1 - November 2020

  • No change in the Cortex API

Cortex 2.6.0 - September 2020

  • The sample rate of the data stream "dev" is now 2 hertz. See Data Subscription for details.
  • macOS 10.12 Sierra is not supported anymore. In order to install Cortex 2.6.0 you must upgrade your Mac to macOS 10.13 High Sierra or above.
Check the Getting Started page to see all the supported headsets and platforms.

Cortex 2.5.0 - June 2020

  • Support the new MN8 headset
  • Support for iOS and Android (Beta release, see the announcement for details)
  • New parameter title added to the method updateRecord​
  • In the method queryRecords, you can now order the records by their applicationId.
  • New warning code 112 and 113
Check the Getting Started page to see all the supported headsets and platforms.

Cortex 2.4.0 - March 2020

Cortex 2.3.0 - December 2019

  • New parameter includeFlexMappings added to the method queryHeadsets​
  • New field lastLoginTime added in the result of the method getUserLogin​

Cortex 2.2.1- October 2019

  • New method added configOptOut​
  • New parameter connectionType added to the method controlDevice​
  • New parameter experimentId added to the method createRecord​
  • New Warning added when the available space on the hard drive is too low
  • New Warning added when the opt-out configuration changes
  • New label isActive in the performance metrics sample object​

Cortex 2.2.0 - September 2019

This version didn't introduce any change in the API.

Cortex 2.1.1 - August 2019

Cortex 2.1.0 - August 2019

  • New methods added to manage the Subjects​

Changes from Cortex 1.x to Cortex V2.0

There are significant changes from Cortex API version 1.x to 2.0.

WebSocket URL

To connect to Cortex 1.x, you used the url wss://emotivcortex.com:54321 In Cortex 2.0, you must use wss://localhost:6868

Authentication

In Cortex 2.0, the user must login with EmotivID through the EMOTIV App. So, the API doesn't have a login or logout method anymore.
Third party applications must be approved by the user before using the Cortex API. See the new method requestAccess.
The method authorize doesn't accept "anonymous mode" anymore. You must provide a client id and client secret.
See Authentication for details.

Headsets

Call the method controlDevice to connect a headset to Cortex. If the headset is not connected, then you can't create a session with this headset.
See Headsets for details.

Miscellaneous

Some methods have been removed or renamed.
Method name in v1
Equivalent in v2
login, logout
See getUserLogin​
acceptLicense
The user must accept the EULA in EMOTIV App. You can call getUserInformation to check if the user already accepted the EULA or not
controlBluetoothHeadset
See controlDevice​
updateNote
See updateRecord​
The parameters and result format of some methods have changed. If you get an error when calling a method, please check its documentation.
Previous
Error Codes
Next
cortexaccess tool
Last modified 8mo ago
Copy link
On this page
Cortex 3.2 - January 2022
Cortex 3.1.3 - December 2021
Cortex 3.1.1, 3.1.2 - December 2021
Cortex 3.1 - December 2021
Cortex 3.0.1 - November 2021
Cortex 3.0 - October 2021
Cortex 2.7.3 - August 2021
Cortex 2.7.2 - July 2021
Cortex 2.7.1 - May 2021
Cortex 2.7.0 - April 2021
Cortex 2.6.4 - March 2021
Cortex 2.6.3 - January 2021
Cortex 2.6.2 - December 2020
Cortex 2.6.1 - November 2020
Cortex 2.6.0 - September 2020
Cortex 2.5.0 - June 2020
Cortex 2.4.0 - March 2020
Cortex 2.3.0 - December 2019
Cortex 2.2.1- October 2019
Cortex 2.2.0 - September 2019
Cortex 2.1.1 - August 2019
Cortex 2.1.0 - August 2019
Changes from Cortex 1.x to Cortex V2.0
WebSocket URL
Authentication
Headsets
Miscellaneous