Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Delete an agent session

beta.agents.sessions.delete(session_id) -> AgentSessionDeleted { id, deleted, object }
DELETE/agents/sessions/{session_id}

Removes a managed agent session from the public API and returns a deletion confirmation. If backend execution has ended, deletion can cancel a still-open public turn and abandon unpublished outputs. Running execution must be cancelled first. Physical cleanup may continue asynchronously. See managing sessions.

ParametersExpand Collapse
session_id: String
minLength0
maxLength1048576
ReturnsExpand Collapse
class AgentSessionDeleted { id, deleted, object }

A Managed Agents session removed from the public API. Physical cleanup may continue asynchronously.

id: String

The ID of the deleted session.

minLength0
deleted: bool

Whether the session has been removed from the public API. Always true. Physical cleanup may still be in progress.

object: :"agent.session.deleted"

The object type. Always agent.session.deleted.

Delete an agent session

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

agent_session_deleted = openai.beta.agents.sessions.delete("session_id")

puts(agent_session_deleted)
{
  "id": "id",
  "deleted": true,
  "object": "agent.session.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "agent.session.deleted"
}