Pause Agent
const url = 'https://api.ultimateteam.ai/api/v1/dogfood/agents/example/pause';const options = { method: 'POST', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"reason":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.ultimateteam.ai/api/v1/dogfood/agents/example/pause \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "reason": "example" }'Pause a C-suite agent on the caller’s tenant.
CEO/Chairman-only. Emits DOGFOOD_AGENT_PAUSED and writes an
audit row. Idempotent on already-paused roles.
Args:
role: One of the 8 C-suite roles.
body: Pause request with optional reason. Audit attribution
always uses the authenticated user, not a supplied actor.
user: Authenticated :class:UserContext (chairman-gated).
service: Injected :class:DogfoodAgentControlService.
Returns:
:class:PauseResponse with paused state + correlation event id.
Raises: HTTPException: 403 if user is not chairman; 400 if role is unknown or the tenant is not in dogfood_live_mode.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Responses
Section titled “ Responses ”Successful Response
Response returned by the pause endpoint.
Attributes:
role: Agent role that was paused (one of the 8 C-suite roles).
paused: Always True on success.
paused_at: UTC timestamp when the pause was recorded.
event_id: Correlation id shared with the
DOGFOOD_AGENT_PAUSED bus event.
object
Examplegenerated
{ "event_id": "example", "paused": true, "paused_at": "2026-04-15T12:00:00Z", "role": "example"}Validation Error
object
object
object
Examplegenerated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}