Skip to main content
POST
End Conversations
Integration Prompt for AI Agents
End multiple running conversations by marking them for termination. Once marked, conversations will end within 20 seconds.

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Body

application/json

Pydantic model for ending multiple conversations

test_result_ids
integer[]
required

List of test result IDs to end

Minimum array length: 1

Response

Successful Response

Response for end conversations request

success
boolean
required

Whether the operation was successful

ended_count
integer
required

Number of conversations marked for ending

test_result_ids
integer[]
required

Test result IDs that were processed

message
string
required

Status message

failed_ids
integer[] | null

Test result IDs that failed to process (if any)