Session Participants

Operations of the Interactive Session API. Paths are relative to your deployment's API host.

GET /api/agent-session-api/sessions/{sessionId}/participants

List the participants of a session. Requires membership of the session audience. Returns every Xema user currently invited, including their role, invited-at, and last-seen-at.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
sessionIdpathstringyes
StatusDescriptionBody
200application/json ListSessionParticipantsResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/agent-session-api/sessions/{sessionId}/participants

Invite an in-org Xema user to a session. Requires management of this session: its owner, or an admin of the organization that owns it (org-owned sessions only). Invited participants and editors may not.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
sessionIdpathstringyes

Request body: application/json InviteParticipantDto

StatusDescriptionBody
201application/json SessionParticipantDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/agent-session-api/sessions/{sessionId}/participants/{participantId}

Remove a participant from a session. Requires management of this session: its owner, or an admin of the organization that owns it (org-owned sessions only). Invited participants and editors may not. The session owner cannot be removed.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
participantIdpathstringyes
sessionIdpathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto