API referenceAgents and workflowsAgent sessions
End a background shell the agent started (a Bash run in the background), by its command; the turn keeps running
Requires the agent_sessions:invoke permission.
AuthorizationBearer <token>
An access token from this zone's POST /oauth/token, or a session token from POST /api/v1/auth/login. Send it as Authorization: Bearer <token>.
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/agent-sessions/string/background-tasks/stop" \ -H "Content-Type: application/json" \ -d '{ "command": "string", "task_id": "string" }'{ "killed": 0}