Devices

End a session (subtract-only)

Anyone with standing may stop; stopping twice is harmless and never touches the mandate.

post/api/v1/device_sessions/{id}/stop

Request

  • Base URL: https://saltapp.ai
  • URL: https://saltapp.ai/api/v1/device_sessions/{id}/stop
  • Auth: API key in header api-key

Path parameters

idstring required

Response

OK.

idstring
agent_idstring
device_idstring
mandate_idstring
chat_idstring

The device lane the encrypted commands ride.

status'queued' | 'requested' | 'active' | 'paused' | 'ended'
requested_atstring date-time
started_atstring date-time nullable
ended_atstring date-time nullable
end_reason'declined' | 'stopped_by_person' | 'stopped_by_agent' | 'stopped_by_device' | 'mandate_revoked' | 'mandate_paused' | 'mandate_expired' | 'mandate_changed' | 'agent_blocked' | 'lost_contact' | 'request_expired' | 'budget_exhausted' | 'duration_limit' | 'device_removed' | 'device_reenrolled' | 'queue_expired' | 'agent_idle' | 'agent_removed' nullable
last_beat_atstring date-time nullable
positioninteger nullable

1-based place in the device's queue while status is queued.

pause_reason'person_active' | 'secure_field' | 'person' | 'other' | 'phone' nullable
lease_expires_atstring date-time nullable

Idle lease; each accepted command (reported by the device) pushes it out. Null while paused.

last_seqinteger

Last command sequence the device reported.

capabilitiesobject
action_countsobject
intentstring nullable

What the agent says it is doing. Agent-authored, untrusted plain text: shown, never interpreted. At most 140 characters after cleaning.

Changes

No recorded changes to this operation across all 2 revisions of this API.