Leave a participant

DELETE

/v1/sessions/{session_id}/participants/{participant_id}

const url = 'https://app.everruns.com/api/v1/sessions/example/participants/example';
const options = {method: 'DELETE'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://app.everruns.com/api/v1/sessions/example/participants/example

Parameters

Path Parameters

session_id

required

string

Session ID (prefixed, e.g., session_…)

participant_id

required

string

Participant ID (prefixed, e.g., part_…)

Responses

200

Participant left successfully

application/json

Session participant - an agent or user that has joined a session.

object

agent_id

Present for agent participants.

string | null

agent_version_id

Immutable agent version captured for an agent participant when known.

string | null

required

Unique identifier for the participant row (format: part_{32-hex}).

string

joined_at

required

string format: date-time

kind

required

Kind of actor participating in a session.

string

Allowed values: agent user

left_at

string | null format: date-time

principal_id

required

Principal that joined the session.

string

role

required

Role a participant has inside a session.

string

Allowed values: host member

session_id

required

Session this participant belongs to.

string

Example

{
  "agent_id": "agent_01933b5a00007000800000000000001",
  "agent_version_id": "agentver_01933b5a00007000800000000000001",
  "id": "part_01933b5a00007000800000000000001",
  "kind": "agent",
  "principal_id": "principal_01933b5a000070008000000000000001",
  "role": "host",
  "session_id": "session_01933b5a00007000800000000000001"
}

400

Invalid ID

404

Session or participant not found

409

Host participant cannot leave through this endpoint

500

Internal server error