Signal that the entire conversation is complete across all sessions. Closing a conversation also closes any remaining open sessions.
URI: /api/v1/agentic/conversations/{conversationId}/close
HTTP Method: POST
Authentication: Bearer JWT
Path Parameters
| Parameter | Required | Description |
|---|---|---|
| conversationId | Yes | Conversation identifier. |
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer JWT token. |
| agent_id | Yes | Registered agent API name. |
Request Body
No request body required.
Response Body Schema
| Field | Type | Description |
|---|---|---|
| statusCode | String | Operation status. Value: closed. |
| conversationId | String | The closed conversation identifier. |
Example Response
Status: 202 Accepted
{
"statusCode": "closed",
"conversationId": "<conversationId>"
}
Error Codes
| Status Code | Description |
|---|---|
| 401 | Unauthorized. Invalid or missing JWT token. |
| 404 | Not Found. Conversation does not exist. |
| 500 | Internal Server Error. |