Close Conversation

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 

ParameterRequiredDescription
conversationIdYesConversation identifier.

Request Headers 

HeaderRequiredDescription
AuthorizationYesBearer JWT token.
agent_idYesRegistered agent API name.

Request Body 

No request body required.

Response Body Schema 

FieldTypeDescription
statusCodeStringOperation status. Value: closed.
conversationIdStringThe closed conversation identifier.

Example Response 

Status: 202 Accepted

1{
2  "statusCode": "closed",
3  "conversationId": "<conversationId>"
4}

Error Codes 

Status CodeDescription
401Unauthorized. Invalid or missing JWT token.
404Not Found. Conversation does not exist.
500Internal Server Error.