DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!
Add additional participants to an active session. Use this endpoint for agent handoffs or multi-agent collaboration.
URI: /api/v1/agentic/conversations/{conversationId}/sessions/{sessionId}/participants
Format: application/json
HTTP Method: POST
Authentication: Bearer JWT
| Parameter | Required | Description |
|---|---|---|
| conversationId | Yes | Conversation identifier. |
| sessionId | Yes | Session identifier. |
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer JWT token. |
| agent_id | Yes | Registered agent API name. |
| Field | Type | Required | Description |
|---|---|---|---|
| participants | Array | Yes | Participants to add. Minimum 1 required. |
| participants[].id | String | Yes | Participant identifier. Use the agent’s registered API name, Individual ID, or User ID depending on participant type. |
| participants[].type | String | Yes | Participant type. Values: individual, employee, agent, or free-form string. |
| participants[].role | String | Yes | Participant role in the session. Values: owner, participant. |
1{
2 "participants": [
3 {
4 "id": "agent-bot-1",
5 "type": "agent",
6 "role": "participant"
7 }
8 ]
9}| Field | Type | Description |
|---|---|---|
| statusCode | String | Operation status. Value: participantsAdded. |
| conversationId | String | Parent conversation identifier. |
| sessionId | String | Parent session identifier. |
Status: 202 Accepted
1{
2 "statusCode": "participantsAdded",
3 "conversationId": "...",
4 "sessionId": "..."
5}| Status Code | Description |
|---|---|
| 400 | Bad Request. Invalid request format or missing required fields. |
| 401 | Unauthorized. Invalid or missing JWT token. |
| 404 | Not Found. Conversation or session does not exist. |
| 500 | Internal Server Error. |