Batch Stop Threads | Athena | API Reference Docs

Stop multiple running thread executions in a single request. This endpoint accepts thread IDs (the same IDs used with the single-thread stop endpoint). Each thread is stopped independently - failures for individual threads do not affect other threads in the batch.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

thread_idslist of stringsRequired

List of thread IDs to stop

Response

Batch stop completed (check results for individual thread status)

failed_countinteger

Number of threads that failed to stop

resultslist of objects

Detailed results for each thread

stopped_countinteger

Number of threads successfully stopped

total_requestedinteger

Total number of threads requested to stop

1	from athena import Athena, ThreadBatchStopRequest
2
3	client = Athena(
4	api_key="YOUR_API_KEY",
5	)
6	client.threads.batch_stop(
7	request=ThreadBatchStopRequest(
8	thread_ids=["thread_ids"],
9	),
10	)

1	{
2	"failed_count": 1,
3	"results": [
4	{
5	"success": true,
6	"thread_id": "thread_12345-6789-abcd-efgh"
7	},
8	{
9	"success": true,
10	"thread_id": "thread_22222-3333-4444-5555"
11	},
12	{
13	"success": false,
14	"thread_id": "thread_99999-8888-7777-6666",
15	"error": "Thread not found"
16	}
17	],
18	"stopped_count": 2,
19	"total_requested": 3
20	}

Authentication

Request

Response

Errors