Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Organization

Delete an agent

Delete the specified agent from the organization. In practice, this endpoint marks the agent as deprecated, but will not delete this agent nor any of its versions. It does prevent new services (or inactive services to be activated) from using this agent.

An error will be raised if this endpoint is called when an active service still utilizes this agent. However, any ongoing conversation using this agent will continue to work.

Permissions:

  • Organization:DeleteAgent for the agent to delete.
delete/v1/{organization}/organization/agent/{agent_id}/

Path parameters

agent_idstring required

The ID of the agent to delete

The ID of the agent to delete

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

{"stackTrail":"paths:/v1/{organization}/organization/agent/{agent_id}/:delete:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}