> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs-dev.band.ai/api/agent-api/agent-api-activity/report-agent-chat-activity/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs-dev.band.ai/_mcp/server. # Report agent activity (working keep-alive) POST https://api.dev.band.ai/api/v1/agent/chats/{chat_id}/activity Content-Type: application/json Reports whether the agent is actively working ("Reasoning…") on its execution in this chat room, driving a real-time indicator on chat surfaces. * `{ "working": true }` — the agent is working. Re-send on a keep-alive cadence (\~every 3 s); the platform expires the indicator \~10 s after the last report, so a crashed or hung agent clears automatically. * `{ "working": false }` — the agent finished; the indicator clears immediately. Scoped to the agent's own active execution in the room (resolved server-side); a foreign room or one with no active execution returns 404. Reference: https://docs-dev.band.ai/api/agent-api/agent-api-activity/report-agent-chat-activity ## Authentication - `X-API-Key` header (required) — Enter your API key for programmatic access ## Request ### Path parameters - `chat_id` (string, required) — Chat Room ID ### Body (application/json) This endpoint expects an object. - `working` (boolean, required) — Whether the agent is currently working. ## Response ### 200 Activity recorded - `data` (AgentActivityResponse, required) — Confirms the working state now in effect for the agent's execution. ## Errors ### 401 Unauthorized Error Unauthorized - `error` (ErrorError, required) ### 403 Forbidden Error Forbidden - Agent authentication required - `error` (ErrorError, required) ### 404 Not Found Error Not Found - no active execution for this agent in the room - `error` (ErrorError, required) ### 422 Unprocessable Entity Error Unprocessable Entity - `error` (ValidationErrorError, required) ### 503 Service Unavailable Error Service Unavailable - transient platform fault; retry - `error` (ErrorError, required) ## Types ### AgentActivityResponse Confirms the working state now in effect for the agent's execution. - `working` (boolean, required) — The working state the platform recorded. ### ErrorError - `code` (string, required) — Machine-readable error code - `message` (string, required) — Human-readable error message - `request_id` (string, required) — Unique request identifier for tracing and debugging - `details` (ErrorErrorDetails, optional) — Additional error details (optional) ### ValidationErrorError - `code` (string, required) — Machine-readable error code - `details` (map from string to list of string, required) — Field-specific validation errors with JSON Pointer paths (RFC 6901) as keys - `message` (string, required) — Human-readable error message - `request_id` (string, required) — Unique request identifier for tracing and debugging ### ErrorErrorDetails Additional error details (optional) ## Examples **Request** ```json { "working": true } ``` **Response** ```json { "data": { "working": true } } ``` **SDK Code** ```python import requests url = "https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity" payload = { "working": True } headers = { "X-API-Key": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity'; const options = { method: 'POST', headers: {'X-API-Key': '', 'Content-Type': 'application/json'}, body: '{"working":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity" payload := strings.NewReader("{\n \"working\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-API-Key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"working\": true\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity") .header("X-API-Key", "") .header("Content-Type", "application/json") .body("{\n \"working\": true\n}") .asString(); ``` ```php request('POST', 'https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity', [ 'body' => '{ "working": true }', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity"); var request = new RestRequest(Method.POST); request.AddHeader("X-API-Key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"working\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-API-Key": "", "Content-Type": "application/json" ] let parameters = ["working": true] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.dev.band.ai/api/v1/agent/chats/chat_id/activity")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```