sessions

Update Session

Update session fields (excludes created_at and updated_at).

Supports three access levels based on session's agent/team:

  • PUBLIC: No authentication required
  • PASSWORD_PROTECTED: X-Access-Password header required
  • PRIVATE: User authentication required

Supports team_identifier and agent_identifier strings to lookup team_id and agent_id. If identifiers are provided and found, the corresponding IDs will be set. If not found, team_id and agent_id will be set to NULL.

patch/api/v1/sessions/{session_id}

Request

  • Base URL: https://api.gnosari.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gnosari.com/api/v1/sessions/{session_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-AUTH-TOKEN

Path parameters

session_idstring required

Headers

X-Access-Passwordstring nullable

Request body

team_idinteger nullable
agent_idinteger nullable
team_identifierstring nullable
agent_identifierstring nullable

Response

Successful Response

session_idstring required
team_idinteger nullable
agent_idinteger nullable
team_identifierstring nullable
agent_identifierstring nullable
summarystring nullable
summary_metadataobject nullable

Metadata from summary generation: key_topics, sentiment, action_items, primary_intent

session_type'USER' | 'INTERNAL' | 'DEBUG'

Session type for visibility control.

Following SOLID principles:

  • Single Responsibility: Each type has one clear visibility pattern
  • Open/Closed: New types can be added without modifying existing code
channel'JOINA_CHAT' | 'QR' | 'WIDGET' | 'INTERNAL' | 'API'

Origin channel a session was created on — informational display metadata.

Set once at creation on the client-known surface (POST /sessions) and surfaced on reads so the Collected Data inbox can render "via joina.chat" per record. Mirrors SessionType's varchar+StrEnum shape MINUS the index.

INFORMATIONAL AND FORGEABLE BY DESIGN: it rides a public unauthenticated POST /sessions and is enum-validated (invalid → 422) but NEVER drives authorization or visibility — that stays session_type. Do not "fix" this as a security hole.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.