> For the complete documentation index, see [llms.txt](https://emotiv.gitbook.io/cortex-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://emotiv.gitbook.io/cortex-api/session/session-object.md).

# Session object

A session is the link between your application and a headset.

You must create a session before you call [subscribe](/cortex-api/data-subscription/subscribe.md) to receive data from a headset. See [createSession](/cortex-api/session/createsession.md).

## Description

A session object includes these fields:

| Name      | Type                    | Description                                                                                                                  |
| --------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| id        | `string`                | The id of this session.                                                                                                      |
| status    | `string`                | Can be "opened", "activated", or "closed".                                                                                   |
| owner     | `string`                | The EmotivID of the user.                                                                                                    |
| license   | `string`                | The id of the license used by this session. Or an empty string if the session wasn't activated.                              |
| appId     | `string`                | The application id of your Cortex app.                                                                                       |
| started   | `string (ISO datetime)` | When this session was created.                                                                                               |
| stopped   | `string (ISO datetime)` | When this session was closed.                                                                                                |
| streams   | `array of strings`      | The data streams you subscribed to. See [subscribe](/cortex-api/data-subscription/subscribe.md).                             |
| recordIds | `array of strings`      | The ids of all the records created by this session. See [createRecord](/cortex-api/records/createrecord.md).                 |
| recording | `boolean`               | True if a record is currently in progress for this session. False otherwise.                                                 |
| headset   | `object`                | A [headset object](/cortex-api/headset/headset-object.md). It contains information about the headset linked to this session. |

### Status

The status is linked to the license. If the session is activated, it will be debited from the quota of the user's license.

| Status    | Description                                                                                                                                                                                                          |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| opened    | The session was created with [createSession](/cortex-api/session/createsession.md), but it doesn't use a license. You can activate or close this session with [updateSession](/cortex-api/session/updatesession.md). |
| activated | The session was activated with a license. You can close this session with [updateSession](/cortex-api/session/updatesession.md).                                                                                     |
| closed    | This session is closed, you cannot use it anymore.                                                                                                                                                                   |

## Examples

A session with an Epoc+ headset. It is not activated. We subscribed to the performance metrics and motion data.

```javascript
{
    "id": "8bfc26de-754b-4c1f-9771-acfd1a7da02c",
    "status": "opened",
    "owner": "jon.snow",
    "license": "",
    "appId": "com.jon.snow.winterfell-app",
    "started": "2019-05-29T14:18:45.108+07:00",
    "stopped": "",
    "headset": {
        "status": "connected"
        "connectedBy": "dongle",
        "customName": "",
        "dongle": "6ff",
        "firmware": "625",
        "id": "EPOCPLUS-3B9AXXXX",
        "motionSensors": [
            "GYROX",
            "GYROY",
            "GYROZ",
            "ACCX",
            "ACCY",
            "ACCZ",
            "MAGX",
            "MAGY",
            "MAGZ"
        ],
        "sensors": [
            "AF3",
            "F7",
            "F3",
            "FC5",
            "T7",
            "P7",
            "O1",
            "O2",
            "P8",
            "T8",
            "FC6",
            "F4",
            "F8",
            "AF4"
        ],
        "settings": {
            "eegRate": 256,
            "eegRes": 16,
            "memsRate": 64,
            "memsRes": 16,
            "mode": "EPOCPLUS"
        }
    },
    "recordIds": [],
    "recording": false,
    "streams": ["met","mot"]
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://emotiv.gitbook.io/cortex-api/session/session-object.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.