resources/beta/subresources/agents/methods/delete/index.md +0 −48 deleted
File Deleted View Diff
1## Delete an agent
2
3**delete** `/agents/{agent_id}`
4
5Deletes a reusable agent. See [agent configuration](/api/docs/guides/agents-api/configuration).
6
7### Path Parameters
8
9- `agent_id: string`
10
11### Returns
12
13- `AgentDeleted object { id, deleted, object }`
14
15 A deleted reusable agent.
16
17 - `id: string`
18
19 The ID of the deleted agent.
20
21 - `deleted: boolean`
22
23 Whether the agent was deleted. Always `true`.
24
25 - `object: "agent.deleted"`
26
27 The object type. Always `agent.deleted`.
28
29 - `"agent.deleted"`
30
31### Example
32
33```http
34curl https://api.openai.com/v1/agents/$AGENT_ID \
35 -X DELETE \
36 -H 'OpenAI-Beta: agents=v1' \
37 -H "Authorization: Bearer $OPENAI_API_KEY"
38```
39
40#### Response
41
42```json
43{
44 "id": "id",
45 "deleted": true,
46 "object": "agent.deleted"
47}
48```