Skip to content

Update editable fields on a session (currently: display_name).

PATCH/api/public/v1/sessions/{session_id}

Terminal window
curl --fail-with-body -X PATCH 'https://app.openlatch.ai/api/public/v1/sessions/<session_id>' \
-H "Authorization: Bearer $OPENLATCH_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"display_name":"release-bot"}'
Role in the organizationThis endpoint
ownerAllowed
adminAllowed
editorAllowed
viewerNot allowed

A key carries the role its owner holds in the organization. See Authentication.

API key scope: agents:write

ParameterTypeDescription
session_idstringRequired.
ParameterTypeDescription
Idempotency-Keystring or nullOptional. Makes the request safe to retry: the same key and the same request, within 24 hours, returns the stored response with Idempotent-Replayed: true and runs once.
FieldTypeDescription
display_namestring or null
FieldTypeDescription
action_mixobjectDomain / file / command action counts rolled up from the agent_action_* tables.
action_mix.commandsinteger
action_mix.domainsinteger
action_mix.filesinteger
agent_display_namestring or nullOwning agent's display name. Populated only by the organization-wide GET /inventory/sessions; null on an agent's own GET /agents/{agent_id}/sessions, where the agent is already known.
agent_idstringRequired.
display_namestring or null
event_countinteger
first_event_atstring (date-time)Required.
initial_promptstring or nullFirst user prompt captured by the ingest normalizer. Redacted + truncated.
intentstring or nullWhat this session was for, in one line. The generated summary's goal when one exists, otherwise the truncated initial_prompt. The same rule resolves the session intent everywhere OpenLatch reports it, so no two reads disagree about when a summary replaces the prompt.
intent_sourcestringWhich of the two intent is: summary (generated), pending (queued, showing the prompt meanwhile) or initial_prompt_fallback. intent is usable text in all three cases; this field records where it came from.
is_orphanboolean
last_event_atstring (date-time)Required.
native_session_idstringRequired.
platformstringRequired. Joined from the parent agents row for display convenience
session_idstringRequired.
verdicts_24hobjectVerdict counts over the last 24h for an Agent or Session.
verdicts_24h.allowintegerActions the policy allowed
verdicts_24h.askintegerActions the policy sent to Ask
verdicts_24h.blockintegerActions the policy blocked
verdicts_24h.totalintegerTotal events in the 24h window
{
"action_mix": {
"commands": 0,
"domains": 0,
"files": 0
},
"agent_display_name": "release-bot",
"agent_id": "agt_01jbwa2k1vfrn9y42xhgxhmzj2",
"display_name": "release-bot",
"event_count": 0,
"first_event_at": "2026-01-15T14:32:05Z",
"initial_prompt": "string",
"intent": "string",
"intent_source": "initial_prompt_fallback",
"is_orphan": false,
"last_event_at": "2026-01-15T14:32:05Z",
"native_session_id": "3f6c1a2e-8b4d-4c1f-9a7e-0d5b2c8e4f10",
"platform": "string",
"session_id": "ses_01jbwa2k1vfrn9y42xhgxhmzj2",
"verdicts_24h": {
"allow": 0,
"ask": 0,
"block": 0,
"total": 0
}
}