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

Delete an agent

beta.agents.delete(agent_id) -> AgentDeleted { id, deleted, object }
DELETE/agents/{agent_id}

Deletes a reusable agent. See agent configuration.

ParametersExpand Collapse
agent_id: String
minLength0
maxLength1048576
ReturnsExpand Collapse
class AgentDeleted { id, deleted, object }

A deleted reusable agent.

id: String

The ID of the deleted agent.

minLength0
deleted: bool

Whether the agent was deleted. Always true.

object: :"agent.deleted"

The object type. Always agent.deleted.

Delete an agent

require "openai"

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

agent_deleted = openai.beta.agents.delete("agent_id")

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