Waiting for engine...
Skip to main content

aiAgentsDelete

Bulk delete multiple AI Agents and their versions from the AI Agent Registry.

Description: This mutation permanently removes multiple AI Agents and their specific versions from the AI Agent Registry in a single operation. For each agent, you can specify which versions to delete, or delete the entire agent with all its versions. At least one agent must be specified for deletion.

Logic for Handling agents array:

The agents array must contain at least one agent entry. Each agent entry will be processed according to its agentVersionIds logic below.

Logic for Handling agentVersionIds (when agents array is provided):

  1. When agentVersionIds is an empty array or not provided: Delete the entire agent and all its versions.

  2. When agentVersionIds contains specific version IDs: Delete only the specified versions.

  3. Post-deletion cleanup: If, after removing the specified versions, no versions remain, delete the agent.

Input Parameters (AiAgentBulkDeleteInput):

  • agents: [AgentReferenceInput!]! - Required. Array of agents to be deleted. Must contain at least one agent.

Agent Input Parameters (AgentReferenceInput):

  • id: ID! - Required. The unique identifier of the AI Agent to be deleted.
  • agentVersionIds: [ID!] - Optional. Array of specific agent version IDs to delete. If empty or not provided, all versions of the agent will be deleted along with the agent itself.

Response:

  • Returns a boolean value indicating the overall success of the bulk deletion operation.

Example Request:

mutation BulkDeleteAiAgents {
   aiAgentsDelete(input: {
      agents: [
         {
            id: "agent-guid"
            agentVersionIds: ["version-guid1", "version-guid2"]
         },
         {
            id: "agent-2-guid"
            agentVersionIds: ["version-guid11", "version-guid21"]
         },
         {
            id: "agent-3-guid"
         },
         {
            id: "agent-4-guid"
            agentVersionIds: []
         },
         {
            id: "agent-5-guid"
            agentVersionIds: null
         }
      ]
   })
}

Example Response:


{
    "data": {
        "aiAgentsDelete": true
    }
}

aiAgentsDelete(
  input: AiAgentBulkDeleteInput!
): Boolean!

Arguments​

aiAgentsDelete.input ● AiAgentBulkDeleteInput! non-null input agent-control-tower

Type​

Boolean scalar miscellaneous

The Boolean scalar type represents true or false.

On this Page