MetorialDocs

Session Participants

Session participants represent the clients and other entities that are connected to a session. This read-only resource tracks who is participating in a session.

The Session Participant object

session_participant.json
{
  "object": "session.participant",
  "id": "spt_5eFgHjKlMnPqRsTu",
  "type": "unknown",
  "identifier": "claude-desktop",
  "name": "Claude Desktop",
  "data": {
    "identifier": "claude-desktop",
    "name": "Claude Desktop"
  },
  "provider_id": "pro_5gHjKlMnPqRsTuVw",
  "connection_type": "mcp",
  "agent_id": "example_agent_id",
  "agent_instance_id": "example_agent_instance_id",
  "identity_actor_id": "example_identity_actor_id",
  "identity_id": "example_identity_id",
  "agent_actor_id": "example_agent_actor_id",
  "agent_client_id": "example_agent_client_id",
  "consumer_id": "example_consumer_id",
  "created_at": "2025-09-15T10:30:00.000Z"
}
object"session.participant"required
idstringrequired
type"unknown" | "provider" | "agent" | "system"required
identifierstringrequired
namestringrequired
provider_idstringrequirednullable
connection_type"mcp" | "metorial_protocol" | "tool_call"requirednullable
agent_idstringrequirednullable
agent_instance_idstringrequirednullable
identity_actor_idstringrequirednullable
identity_idstringrequirednullable
agent_actor_idstringrequirednullable
agent_client_idstringrequirednullable
consumer_idstringrequirednullable
created_atdaterequired

Endpoints

List session participants

GET/session-participants

Returns a paginated list of participants in a session.

Query parameters

type"unknown" | "provider" | "system" | "tool_call" | "mcp_client" | "metorial_protocol_client" or "unknown" | "provider" | "system" | "tool_call" | "mcp_client" | "metorial_protocol_client"[]optional

Filter by participant type(s)

idstring or string[]optional

Filter by participant ID(s)

agent_idstring or string[]optional

Filter by connected agent ID(s)

actor_idstring or string[]optional

Filter by connected identity actor ID(s)

consumer_idstring or string[]optional

Filter by connected consumer ID(s)

identity_idstring or string[]optional

Filter by connected identity ID(s)

agent_instance_idstring or string[]optional

Filter by connected agent instance ID(s)

session_idstring or string[]optional

Filter by session ID(s)

session_connection_idstring or string[]optional

Filter by session connection ID(s)

session_message_idstring or string[]optional

Filter by session message ID(s)

Example request

curl -X GET "https://api.metorial.com/session-participants" \
  -H "Authorization: Bearer metorial_sk_io2h4..."

Get session participant

GET/session-participants/:session_participant_id

Retrieves a specific participant in a session.

Path parameters

session_participant_idstringrequired

The unique identifier for the session_participant

Example request

curl -X GET "https://api.metorial.com/session-participants/ses_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_io2h4..."