Delete Agent by ID

client.agents.delete(, ?): DeleteResponse { id, message }

DELETE/agents/{agent_id}

Delete an agent by its unique ID.

ParametersExpand Collapse

agentID: string

ReturnsExpand Collapse

DeleteResponse { id, message }

id: string

message: string

Delete Agent by ID

import Agentex from 'agentex';

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

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

console.log(deleteResponse.id);

{
  "id": "id",
  "message": "message"
}

Returns Examples

{
  "id": "id",
  "message": "message"
}