Skip to content

Notion: Sessions schemas

11 Notion schemas with complete fields and constraints.

← Sessions operations · All schemas

Query session events — request body — body / filter / property: created at

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
propertystringRequired within parentOne of: created_at
timestampobjectRequired within parentAdditional keys: not allowed
timestamp.afterstringOptionalFormat: date-time
timestamp.beforestringOptionalFormat: date-time
timestamp.equalsstringOptionalFormat: date-time
timestamp.on_or_afterstringOptionalFormat: date-time
timestamp.on_or_beforestringOptionalFormat: date-time

Query session events — request body — body / filter / property: type

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
event_typeobjectRequired within parentAdditional keys: not allowed
event_type.equalsstringOptionalOne of: user.message, agent.message, agent.thinking, agent.tool_use, agent.tool_result, session.status
event_type.inarrayOptional
event_type.in[]stringEach itemOne of: user.message, agent.message, agent.thinking, agent.tool_use, agent.tool_result, session.status
propertystringRequired within parentOne of: type

Query session events — request body — body filter or or item and

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
andarrayRequired within parent
and[]JSONEach item
and[] (oneOf 1)objectAlternativeAdditional keys: not allowed
and[] (oneOf 1).propertystringRequired within parentOne of: id
and[] (oneOf 1).stringobjectRequired within parentAdditional keys: not allowed
and[] (oneOf 1).string.equalsstringRequired within parent
and[] (oneOf 2)ModelAlternativeExpand Query session events — request body — body / filter / property: type
and[] (oneOf 3)objectAlternativeAdditional keys: not allowed
and[] (oneOf 3).numberobjectRequired within parentAdditional keys: not allowed
and[] (oneOf 3).number.greater_thannumberOptional
and[] (oneOf 3).number.greater_than_or_equal_tonumberOptional
and[] (oneOf 3).number.less_thannumberOptional
and[] (oneOf 3).number.less_than_or_equal_tonumberOptional
and[] (oneOf 3).propertystringRequired within parentOne of: sequence
and[] (oneOf 4)ModelAlternativeExpand Query session events — request body — body / filter / property: created at
and[] (oneOf 5)ModelAlternativeExpand Query session events — request body — body filter or or item or or item and
and[] (oneOf 6)ModelAlternativeExpand Query session events — request body — body filter or or item or or item or

Referenced models: Query session events — request body — body filter or or item or or item and, Query session events — request body — body filter or or item or or item or, Query session events — request body — body / filter / property: created at, Query session events — request body — body / filter / property: type

Query session events — request body — body filter or or item or

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
orarrayRequired within parent
or[]JSONEach item
or[] (oneOf 1)objectAlternativeAdditional keys: not allowed
or[] (oneOf 1).propertystringRequired within parentOne of: id
or[] (oneOf 1).stringobjectRequired within parentAdditional keys: not allowed
or[] (oneOf 1).string.equalsstringRequired within parent
or[] (oneOf 2)ModelAlternativeExpand Query session events — request body — body / filter / property: type
or[] (oneOf 3)objectAlternativeAdditional keys: not allowed
or[] (oneOf 3).numberobjectRequired within parentAdditional keys: not allowed
or[] (oneOf 3).number.greater_thannumberOptional
or[] (oneOf 3).number.greater_than_or_equal_tonumberOptional
or[] (oneOf 3).number.less_thannumberOptional
or[] (oneOf 3).number.less_than_or_equal_tonumberOptional
or[] (oneOf 3).propertystringRequired within parentOne of: sequence
or[] (oneOf 4)ModelAlternativeExpand Query session events — request body — body / filter / property: created at
or[] (oneOf 5)ModelAlternativeExpand Query session events — request body — body filter or or item or or item and
or[] (oneOf 6)ModelAlternativeExpand Query session events — request body — body filter or or item or or item or

Referenced models: Query session events — request body — body filter or or item or or item and, Query session events — request body — body filter or or item or or item or, Query session events — request body — body / filter / property: created at, Query session events — request body — body / filter / property: type

Query session events — request body — body filter or or item or or item and

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
andarrayRequired within parent
and[]JSONEach item
and[] (oneOf 1)objectAlternativeAdditional keys: not allowed
and[] (oneOf 1).propertystringRequired within parentOne of: id
and[] (oneOf 1).stringobjectRequired within parentAdditional keys: not allowed
and[] (oneOf 1).string.equalsstringRequired within parent
and[] (oneOf 2)ModelAlternativeExpand Query session events — request body — body / filter / property: type
and[] (oneOf 3)objectAlternativeAdditional keys: not allowed
and[] (oneOf 3).numberobjectRequired within parentAdditional keys: not allowed
and[] (oneOf 3).number.greater_thannumberOptional
and[] (oneOf 3).number.greater_than_or_equal_tonumberOptional
and[] (oneOf 3).number.less_thannumberOptional
and[] (oneOf 3).number.less_than_or_equal_tonumberOptional
and[] (oneOf 3).propertystringRequired within parentOne of: sequence
and[] (oneOf 4)ModelAlternativeExpand Query session events — request body — body / filter / property: created at

Referenced models: Query session events — request body — body / filter / property: created at, Query session events — request body — body / filter / property: type

Query session events — request body — body filter or or item or or item or

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
orarrayRequired within parent
or[]JSONEach item
or[] (oneOf 1)objectAlternativeAdditional keys: not allowed
or[] (oneOf 1).propertystringRequired within parentOne of: id
or[] (oneOf 1).stringobjectRequired within parentAdditional keys: not allowed
or[] (oneOf 1).string.equalsstringRequired within parent
or[] (oneOf 2)ModelAlternativeExpand Query session events — request body — body / filter / property: type
or[] (oneOf 3)objectAlternativeAdditional keys: not allowed
or[] (oneOf 3).numberobjectRequired within parentAdditional keys: not allowed
or[] (oneOf 3).number.greater_thannumberOptional
or[] (oneOf 3).number.greater_than_or_equal_tonumberOptional
or[] (oneOf 3).number.less_thannumberOptional
or[] (oneOf 3).number.less_than_or_equal_tonumberOptional
or[] (oneOf 3).propertystringRequired within parentOne of: sequence
or[] (oneOf 4)ModelAlternativeExpand Query session events — request body — body / filter / property: created at

Referenced models: Query session events — request body — body / filter / property: created at, Query session events — request body — body / filter / property: type

Query sessions — request body — body / filter / property: agent id

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
propertystringRequired within parentFilter sessions by agent_id.
One of: agent_id
stringobjectRequired within parentAn exact string comparison.
Additional keys: not allowed
string.equalsstringRequired within parentReturn sessions with this exact value.

Query sessions — request body — body / filter / property: created at, updated at

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
propertystringRequired within parentThe session timestamp to compare.
One of: created_at, updated_at
timestampobjectRequired within parentA timestamp range.
Additional keys: not allowed
timestamp.afterstringOptionalReturn sessions after this time.
Format: date-time
timestamp.beforestringOptionalReturn sessions before this time.
Format: date-time
timestamp.on_or_afterstringOptionalReturn sessions at or after this time.
Format: date-time
timestamp.on_or_beforestringOptionalReturn sessions at or before this time.
Format: date-time

Query sessions — request body — body / filter / property: id

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
propertystringRequired within parentFilter sessions by id.
One of: id
stringobjectRequired within parentAn exact string comparison.
Additional keys: not allowed
string.equalsstringRequired within parentReturn sessions with this exact value.

Query sessions — request body — body / filter / property: status

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
propertystringRequired within parentFilter sessions by status.
One of: status
statusobjectRequired within parentA session status comparison.
Additional keys: not allowed
status.equalsstringOptionalReturn sessions with this status.
One of: queued, in_progress, requires_action, completed, failed, canceled, terminated
status.inarrayOptionalReturn sessions with any of these statuses.
Maximum items: 7
status.in[]stringEach itemOne of: queued, in_progress, requires_action, completed, failed, canceled, terminated

Query sessions — request body — body filter or or item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Query sessions — request body — body / filter / property: id
$ (oneOf 2)ModelAlternativeExpand Query sessions — request body — body / filter / property: agent id
$ (oneOf 3)ModelAlternativeExpand Query sessions — request body — body / filter / property: status
$ (oneOf 4)ModelAlternativeExpand Query sessions — request body — body / filter / property: created at, updated at
$ (oneOf 5)objectAlternativeAdditional keys: not allowed
$ (oneOf 5).andarrayRequired within parentReturn sessions that match every child filter.
Maximum items: 100
$ (oneOf 5).and[]JSONEach item
$ (oneOf 5).and[] (oneOf 1)ModelAlternativeExpand Query sessions — request body — body / filter / property: id
$ (oneOf 5).and[] (oneOf 2)ModelAlternativeExpand Query sessions — request body — body / filter / property: agent id
$ (oneOf 5).and[] (oneOf 3)ModelAlternativeExpand Query sessions — request body — body / filter / property: status
$ (oneOf 5).and[] (oneOf 4)ModelAlternativeExpand Query sessions — request body — body / filter / property: created at, updated at
$ (oneOf 6)objectAlternativeAdditional keys: not allowed
$ (oneOf 6).orarrayRequired within parentReturn sessions that match any child filter.
Maximum items: 100
$ (oneOf 6).or[]JSONEach item
$ (oneOf 6).or[] (oneOf 1)ModelAlternativeExpand Query sessions — request body — body / filter / property: id
$ (oneOf 6).or[] (oneOf 2)ModelAlternativeExpand Query sessions — request body — body / filter / property: agent id
$ (oneOf 6).or[] (oneOf 3)ModelAlternativeExpand Query sessions — request body — body / filter / property: status
$ (oneOf 6).or[] (oneOf 4)ModelAlternativeExpand Query sessions — request body — body / filter / property: created at, updated at

Referenced models: Query sessions — request body — body / filter / property: agent id, Query sessions — request body — body / filter / property: id, Query sessions — request body — body / filter / property: status, Query sessions — request body — body / filter / property: created at, updated at

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.