Delete an agent

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

DELETE

/agents/{agent_id}

Deletes a reusable agent. See agent configuration.

agent_id: String

minLength0

maxLength1048576

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.

Ruby

require "openai"

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

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

puts(agent_deleted)

200 — Example

{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}

200 — Example

{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}