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

client.beta.agents.delete(stringagentID, RequestOptionsoptions?): AgentDeleted { id, deleted, object }
DELETE/agents/{agent_id}

Deletes a reusable agent. See agent configuration.

ParametersExpand Collapse
agentID: string
minLength0
maxLength1048576
ReturnsExpand Collapse
AgentDeleted { id, deleted, object }

A deleted reusable agent.

id: string

The ID of the deleted agent.

minLength0
deleted: boolean

Whether the agent was deleted. Always true.

object: "agent.deleted"

The object type. Always agent.deleted.

Delete an agent

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const agentDeleted = await client.beta.agents.delete('agent_id');

console.log(agentDeleted.id);
{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}