aiAgentDelete
Delete a single AI Agent with all sub-entities from the AI Agent Registry.
Description: This mutation permanently removes one AI Agent from the AI Agent Registry by its unique identifier. The agent and all its sub-entities are deleted. The operation either completes successfully or fails with a GraphQL Error; there is no partial deletion.
Implementation logic For the given agent ID:
- Delete the agent and all its versions.
- Delete all aliases for those versions.
- Remove all associations from the agent and its versions. Associated entities (tasks, tools, guardrails, LLMs) are deleted only if no other agents are using them; tags are removed with the versions.
The entire operation runs in a single transaction. On success, returns true. On any failure, roll back and return a GraphQL Error.
Input Parameters:
id: ID! — Required. The unique identifier of the AI Agent to be deleted.
Response:
- On success: returns
true. - On failure: a GraphQL Error is returned and no changes are applied.
Example Request:
mutation DeleteAiAgent {
aiAgentDelete(id: "ai-agent-unique-identifier")
}
Example Response (success):
{
"data": {
"aiAgentDelete": true
}
}
aiAgentDelete(
id: ID!
): Boolean!
Arguments
aiAgentDelete.id ● ID! non-null scalar miscellaneous
Type
Boolean scalar miscellaneous
The Boolean scalar type represents true or false.
Was this topic helpful?