Waiting for engine...
Skip to main content

aiAgentVersionUpdate

Update an existing AI Agent Version in the AI Agent Registry.

Description: This mutation updates a specific AI Agent Version associated with the authenticated user's account using the version ID.

Uniqueness Constraint: Within a given provider account, each AI Agent must be unique by the combination of agent name and version. When updating the name or version fields, ensure the resulting combination does not conflict with existing agents.

Input Parameters (AiAgentVersionUpdateInput):

  • versionId: ID! - Required. Unique identifier of the AI agent version to be updated.
  • name: String - Optional. Title of the AI agent version.
  • version: String - Optional. Version identifier of the AI agent version (supports alphanumeric characters). Note: Can only be edited while its value is DRAFT. Once moved out of DRAFT, becomes fixed.
  • description: String - Optional. Detailed information about the AI agent's version capabilities and features.
  • externalId: ID - Optional. External identifier for the AI agent version in the provider system.
  • tags: [AiAgentTagInput!] - Optional. Array of tags for classification and organization.
  • trustLevel: AiAgentRegistryTrustLevel - Optional. Confidence and reliability level of the AI agent version.
  • versionMetadata: String - Optional. Metadata for the agent version in JSON format.

Response:

  • Returns the AiAgent object containing the updated agent version.

Example Request:

mutation UpdateAiAgentVersion {
aiAgentVersionUpdate(input: {
versionId: "version-guid-12345",
name: "Enhanced Customer Support Agent",
version: "2.1",
description: "Updated version with improved natural language processing and enhanced customer query handling capabilities",
externalId: "ext-version-cs-agent-v2.1",
status: ACTIVE
tags: [
{
key: "department",
value: "customer-service"
},
{
key: "priority",
value: "high"
}
],
trustLevel: ENDORSED,
versionMetadata: "{ \"deployment\": \"production\", \"environment\": \"stable\", \"features\": [\"nlp-enhanced\", \"multi-language\"] }"
}) {
id
externalId
createdByOrigin
agentVersions {
id
externalId
version
name
description
trustLevel
agentStatus
versionMetadata
tags {
id
key
value
}
auditData {
createdByUserId
createdTime
modifiedByUserId
modifiedTime
}
}
}
}

aiAgentVersionUpdate(
input: AiAgentVersionUpdateInput!
): AiAgent

Arguments

aiAgentVersionUpdate.input ● AiAgentVersionUpdateInput! non-null input agent-control-tower

Type

AiAgent object agent-control-tower

On this Page