Waiting for engine...
Skip to main content

aiAgentListings

Description:

The aiAgentListings query is designed retrieve a list of AI Agents registered in the AI Agent Registry associated with the authenticated user's account.

Input Parameters (AiAgentsQueryInput):

  • offset: Int - Zero-based index for pagination (must not be negative). Default is 0
  • limit: 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.
  • 'searchInput: String - This text will be searched in providerName/aliasName/versionName/trustLevel and matching agents will be returned
  • 'agentListingFilter' : This filter can be provider Type,provider account,tags,llms and trustlevel

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.
  • aiAgentListings: [AiAgentListing!] - Array of AI Agents.

Output aiAgentStatusCount of (AiAgentsListingQueryResponse):

  • aiAgentStatusCount: Object - Provides a count of AI agents categorized by their status. The aiAgentStatusCount is only available when a specific filter type, providerType, is selected from the user interface. The data is computed for all records per idp account id not on the paginated data.
  • status: String - Represents the AgentStatus category of the AI agents.
  • count: Int - The number of AI agents corresponding to each status category.

Example Request:

query {
aiAgentListings(input: {
offset: 0
limit: 10
searchInput: "agent"
agentListingFilter: {
filterInput: {
accounts: ["e2d4d7cf-79d9-4f90-9be8-b8dd4e9e9a25"]
models: ["Claude 3.5 Sonnet"]
providers: [AWS_BEDROCK]
trustLevel: [UNENDORSED, ENDORSED]
}
condition: OR
}
}) {
numberOfResults
currentPageSize
aiAgentListings {
idpAccountId
providerType
providerSubType
providerAccountGuId
providerAccountName
versionGuid
versionName
version
description
agentStatus
trustLevel
aliasGuid
aliasName
taskIds
llms {
guid
name
}
modifiedTime
hasAlias
toolGuids
aliasTags {
id
key
}
versionTags {
id
key
}
}
aiAgentStatusCount {
status
count
}
}
}

aiAgentListings(
input: AiAgentsListingQueryInput
): AiAgentsListingQueryResponse

Arguments

aiAgentListings.input ● AiAgentsListingQueryInput input agent-control-tower

Type

AiAgentsListingQueryResponse object agent-control-tower

On this Page