Waiting for engine...
Skip to main content

aiAgents

Retrieve a list of AI Agents registered in the AI Agent Registry associated with the authenticated user's account.

Description: This query returns a paginated list of AI Agents linked to specific AI Agent Provider accounts.

Input Parameters (AiAgentsQueryInput):

  • pageIndex: Int - Zero-based page index for pagination (must not be negative). Default is 0
  • pageSize: Int - Number of items per page (must be greater than 0). Default is 10
  • providerAccountIds: [ID!] - Optional. An array of unique identifiers for the AI Agent Provider account to filter the results.

Response (AiAgentsQueryResponse):

  • numberOfResults: Long - Total number of AI Agents available for the specified account IDs.
  • currentPageSize: Int - Number of AI Agents in the current page.
  • aiAgents: [AiAgent!] - Array of AI Agents. The externalLink property is not returned for any of the Types

Example Request:

query {
aiAgents(input: {
providerAccountIds: ["ai-registry-account-123"]
pageIndex: 0,
pageSize: 10
}) {
numberOfResults
currentPageSize
aiAgents {
id
externalId
createdByOrigin
providerAccountSummary {
providerType
providerAccountName
externalProviderAccountId
}
agentVersions {
id
externalId
version
name
description
region
purpose
personalityTraitsJson
instructions
agentStatus
versionMetadata
agentAliases {
id
name
description
}
tags {
id
key
value
}
agentTools {
id
name
externalId
version
description
provider
type
json
status
resources {
id
name
description
resourceType
json
status
}
agentVersion {
id
externalId
version
name
description
region
purpose
personalityTraitsJson
instructions
agentStatus
versionMetadata
}
tasks {
id
externalId
version
name
description
taskStatus
metaData
instructions
syncData {
lastSyncStatus
lastSyncStartDate
lastSyncEndDate
}
auditData {
createdByUserId
createdTime
modifiedByUserId
modifiedTime
updatedByOrigin
updatedAtProviderTime
}
}
}
llms {
id
name
description
version
}
inputSchema
outputSchema
ioSchemaVersion
usageMode
invocationSpecs {
spec
protocol
}
syncData {
lastSyncStatus
lastSyncStartDate
lastSyncEndDate
}
auditData {
createdByUserId
createdTime
modifiedByUserId
modifiedTime
createdByOrigin
updatedByOrigin
updatedAtProviderTime
}
}
}
}
}

aiAgents(
input: AiAgentsQueryInput
): AiAgentsQueryResponse

Arguments

aiAgents.input ● AiAgentsQueryInput input agent-control-tower

Type

AiAgentsQueryResponse object agent-control-tower

On this Page