aiAgentUpdate

Update an existing AI Agent in the AI Agent Registry.

Description: This mutation updates the AI Agent associated with the authenticated user’s account. Either id or externalId must be provided to identify the agent for updating.

Input Parameters (AiAgentUpdateInput):

• id: ID! - Required. Unique identifier of the internal AI agent to be updated
• versionId: ID! - Required. Unique identifier of the internal AI agent version to be updated
• agentVersion: String - Optional. The version of the AI agent (could be null, "DRAFT", or numeric).
• agentName: String - Required. Name of the AI agent.
• externalId: ID - Optional. External identifier for the AI agent in the provider system.
• agentDescription: String - Optional. Description of the AI agent.
• region: String - Optional. The region associated with the AI agent.
• purpose: String - Optional. Purpose of the AI agent in JSON format.
• personalityTraitsJson: String - Optional. Personality traits in JSON format.
• instructions: String - Optional. Specific instructions for the AI agent.
• agentStatus: AgentStatus - Optional. Status of the AI agent (e.g., PREPARING, RUNNING).
• tags: Array of type AiAgentTagInput - Optional
• versionMetadata: String - Optional. Metadata for the version in JSON format

Response:

• Returns the updated AiAgent object.

Example Request:

mutation {
    aiAgentUpdate(input: {
        # Guid of the agent
        id: "agent-123",
        # Alternatively, you can use externalId
        # externalId: "agent123",
        # version guid
        versionId: "123243-asdf-42-23w"
        agentVersion: "1.1",
        agentName: "Alpha Updated",
        externalId: "ext-agent-alpha-002",
        agentDescription: "Updated description of the AI agent",
        region: "us-west-2",
        purpose: "{\"name\": \"integration\"}",
        personalityTraitsJson: "{\"friendly\": true, \"helpful\": false}",
        instructions: "Assist customers with inquiries, responds in a polite manner.",
        agentStatus: RUNNING,
        tags: [
           {
               key: "priority",
               value: "urgent"
           }
       ],
       trustLevel: ENDORSED,
       versionMetadata: "{ \"deployment\": \"production\", \"environment\": \"stable\" }",
       metaData: "{ \"department\": \"support\" }"
    }) {
        id
        externalId
        createdByOrigin
        agentVersions {
          id
          externalId
          version
          name
          description
          region
          purpose
          personalityTraitsJson
          instructions
          agentStatus
          versionMetadata
          tags {
              id
              key
              value
          }
          llms {
              id
              name
              description
              version
          }
          syncData {
              lastSyncStatus
              lastSyncStartDate
              lastSyncEndDate
          }
          auditData {
              createdByUserId
              createdTime
              modifiedByUserId
              modifiedTime
              createdByOrigin
              updatedByOrigin
              updatedAtProviderTime
          }
        }
    }
}

aiAgentUpdate(
  input: AiAgentUpdateInput!
): AiAgent

Arguments

aiAgentUpdate.input ● AiAgentUpdateInput! non-null input agent-control-tower

Type

AiAgent object agent-control-tower