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

AgentDeleted beta().agents().delete(AgentDeleteParamsparams = AgentDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/agents/{agent_id}

Deletes a reusable agent. See agent configuration.

ParametersExpand Collapse
AgentDeleteParams params
Optional<String> agentId
minLength0
maxLength1048576
ReturnsExpand Collapse
class AgentDeleted:

A deleted reusable agent.

String id

The ID of the deleted agent.

minLength0
boolean deleted

Whether the agent was deleted. Always true.

JsonValue; object_ "agent.deleted"constant"agent.deleted"constant

The object type. Always agent.deleted.

Delete an agent

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.beta.agents.AgentDeleteParams;
import com.openai.models.beta.agents.AgentDeleted;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        AgentDeleted agentDeleted = client.beta().agents().delete("agent_id");
    }
}
{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "agent.deleted"
}