Waiting for engine...
Skip to main content

aiAgentAliases

The aiAgentAliases query retrieves the list of AI agent aliases for the given providers and provider accounts. This query is used to populate the runtime dropdown in the agent metrics UI, allowing users to filter metrics by a specific runtime (alias). When multiple filters are specified, the query returns aliases matching ALL provided filters (AND logic).

Input Parameters (AiAgentAliasesInput):

  • providerTypes: Array of type AiAgentProviderType - Optional. It allows filtering based on the types of AI agent provider.
  • providerAccountIds: Array of UUID strings - Optional. It filters the records based on the unique identifier of the provider's accounts.
  • providerSubTypes: Array of type AiAgentProviderSubType - Optional. It allows filtering based on the sub-types of AI agent provider (e.g. AZURE_OPENAI, BEDROCK). Not applicable for BOOMI providers.

Response:

  • Returns a list of AiAgentAlias objects, each containing the alias name (used as the display label) and externalId (used as the filter value when querying metrics). The gardenRuntime field is populated when the alias is associated with a garden runtime environment.

Example Request:

    query {
aiAgentAliases(input: {
providerTypes: [CUSTOM]
providerAccountIds: ["provider-account-guid-1"]
providerSubTypes: [LANGCHAIN]
}) {
id
name
externalId
gardenRuntime {
id
name
externalId
}
}
}

aiAgentAliases: [AiAgentAlias!]

Type

AiAgentAlias object agent-control-tower

On this Page