Waiting for engine...
Skip to main content

aiAgentByVersionId

Retrieve an AI Agent registered in the AI Agent Registry using the AI Agent version ID associated with the authenticated user's account.

Description: This query returns the details of a specific AI Agent linked to the provided AI Agent version ID.

Input Parameters:

  • aiAgentVersionId: ID! - Required. The unique identifier of the AI Agent version in the AI Registry system; used to identify the agent for retrieval.

Response:

  • Returns an AiAgent object containing the details of the AI Agent associated with the provided version ID. The externalLink property is returned for the AI Agent and the AI Agent version types

Example Request:

query {
aiAgentByVersionId(aiAgentVersionId: "version-123") {
id
externalId
externalLink
createdByOrigin
providerAccountSummary {
providerType
providerAccountName
externalProviderAccountId
}
agentVersions {
id
externalId
version
name
description
region
purpose
personalityTraitsJson
instructions
agentStatus
externalLink
versionMetadata
agentAliases {
id
name
description
}
tags {
id
key
value
}
llms {
id
name
description
version
}
syncData {
lastSyncStatus
lastSyncStartDate
lastSyncEndDate
}
auditData {
createdByUserId
createdTime
modifiedByUserId
modifiedTime
createdByOrigin
updatedByOrigin
updatedAtProviderTime
}
}
}
}

aiAgentByVersionId(
aiAgentVersionId: ID!
): AiAgent

Arguments

aiAgentByVersionId.aiAgentVersionId ● ID! non-null scalar miscellaneous

Type

AiAgent object agent-control-tower

On this Page