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(stragent_id) -> AgentDeleted
DELETE/agents/{agent_id}

Deletes a reusable agent. See agent configuration.

ParametersExpand Collapse
agent_id: str
minLength0
maxLength1048576
ReturnsExpand Collapse
class AgentDeleted: …

A deleted reusable agent.

id: str

The ID of the deleted agent.

minLength0
deleted: bool

Whether the agent was deleted. Always true.

object: Literal["agent.deleted"]

The object type. Always agent.deleted.

Delete an agent

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
agent_deleted = client.beta.agents.delete(
    "agent_id",
)
print(agent_deleted.id)
{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}