Update editable fields on a session (currently: display_name).
PATCH/api/public/v1/sessions/{session_id}
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"}'import jsonimport osimport urllib.request
body = '{"display_name":"release-bot"}'request = urllib.request.Request( 'https://app.openlatch.ai/api/public/v1/sessions/<session_id>', method='PATCH', data=body.encode(), headers={ 'Authorization': 'Bearer ' + os.environ['OPENLATCH_API_KEY'], 'Content-Type': 'application/json', },)with urllib.request.urlopen(request) as response: text = response.read().decode() print(json.dumps(json.loads(text), indent=2) if text else response.status)#!/usr/bin/env bashset -euo pipefail
curl -sS --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"}' | jq .$headers = @{ Authorization = "Bearer $env:OPENLATCH_API_KEY"}$body = '{"display_name":"release-bot"}'Invoke-RestMethod -Method PATCH -Uri 'https://app.openlatch.ai/api/public/v1/sessions/<session_id>' -Headers $headers -ContentType 'application/json; charset=utf-8' -Body $body | ConvertTo-Json -Depth 20Authorization
Section titled “Authorization”| Role in the organization | This endpoint |
|---|---|
owner | Allowed |
admin | Allowed |
editor | Allowed |
viewer | Not allowed |
A key carries the role its owner holds in the organization. See Authentication.
API key scope: agents:write
Path parameters
Section titled “Path parameters”| Parameter | Type | Description |
|---|---|---|
session_id | string | Required. |
Header parameters
Section titled “Header parameters”| Parameter | Type | Description |
|---|---|---|
Idempotency-Key | string or null | Optional. 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. |
Request body
Section titled “Request body”| Field | Type | Description |
|---|---|---|
display_name | string or null |
Response
Section titled “Response”- 200 OK — the call succeeded.
- 400 Bad Request —
BAD_REQUEST - 401 Unauthorized —
UNAUTHORIZED - 402 Payment Required —
license_expired - 403 Forbidden —
FEATURE_DISABLED,FORBIDDEN,INSUFFICIENT_SCOPE - 404 Not Found —
NOT_FOUND - 409 Conflict —
IDEMPOTENCY_IN_PROGRESS - 422 Unprocessable Content —
IDEMPOTENCY_KEY_REUSED,INVALID_ID,VALIDATION_ERROR - 429 Too Many Requests —
TOO_MANY_REQUESTS - 500 Internal Server Error —
INTERNAL_SERVER_ERROR,tenant_isolation_violation - 503 Service Unavailable —
FEATURE_STATE_UNAVAILABLE,SERVICE_UNAVAILABLE
Response fields
Section titled “Response fields”| Field | Type | Description |
|---|---|---|
action_mix | object | Domain / file / command action counts rolled up from the agent_action_* tables. |
action_mix.commands | integer | |
action_mix.domains | integer | |
action_mix.files | integer | |
agent_display_name | string or null | Owning 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_id | string | Required. |
display_name | string or null | |
event_count | integer | |
first_event_at | string (date-time) | Required. |
initial_prompt | string or null | First user prompt captured by the ingest normalizer. Redacted + truncated. |
intent | string or null | What 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_source | string | Which 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_orphan | boolean | |
last_event_at | string (date-time) | Required. |
native_session_id | string | Required. |
platform | string | Required. Joined from the parent agents row for display convenience |
session_id | string | Required. |
verdicts_24h | object | Verdict counts over the last 24h for an Agent or Session. |
verdicts_24h.allow | integer | Actions the policy allowed |
verdicts_24h.ask | integer | Actions the policy sent to Ask |
verdicts_24h.block | integer | Actions the policy blocked |
verdicts_24h.total | integer | Total events in the 24h window |
Example response
Section titled “Example response”{ "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 }}