Sample - OpenAI API
POST/agents/sessions/{session_id}

Update an agent session

Updates session metadata. Omitted fields are unchanged. See managing sessions.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
session_idstringrequired
The ID of the session.
metadataobjectoptional
Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it. Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.

8 status codes
200The updated session.
metadataobjectrequired
Custom string key-value pairs attached to the session.
idstringrequired
The ID of the session.
objectstringrequired
The object type. Always `agent.session`.
Allowed:agent.sessionDefault:agent.session
created_atintegerrequired
The Unix timestamp, in seconds, when the session was created.
last_active_atintegerrequired
The Unix timestamp, in seconds, when the session was last active.
statusstringrequired
The current status of the session.
Allowed:idlein_progressrequires_actionfailed
required_actionsarray<object>required
Actions that must be completed before the session can continue.
errorstringrequired
The error that caused the session to fail, if any.
agentobjectrequired
The agent running in the session.
environmentobjectrequired
The execution environment for the session.
vault_idsarray<string>required
The IDs of vaults made available to the session.
usageobjectrequired
Best-effort token usage for the session, or null if unknown. Recorded usage may change.
400The request was invalid.
errorobjectrequired
The error returned by the API.
401Authentication or project context was missing.
errorobjectrequired
The error returned by the API.
403The API key lacks the required Responses permission.
errorobjectrequired
The error returned by the API.
404The requested session or event was not found.
errorobjectrequired
The error returned by the API.
409The request conflicted with the current session state.
errorobjectrequired
The error returned by the API.
500An internal error occurred.
errorobjectrequired
The error returned by the API.
503The service is temporarily unavailable.
errorobjectrequired
The error returned by the API.

Error handling

A 400 is returned: The request was invalid. A 401 is returned: Authentication or project context was missing. A 403 is returned: The API key lacks the required Responses permission. A 404 is returned: The requested session or event was not found. A 409 is returned: The request conflicted with the current session state. A 500 is returned: An internal error occurred. A 503 is returned: The service is temporarily unavailable.