List agents a runtime target can use

channelAgents(projectReference: ID!, input: ChannelAgentsInput): ChannelAgentList!

Requires project.channels.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject UUID or slug.
inputChannelAgentsInputNo

Input fields

input

ChannelAgentsInput

FieldTypeRequiredDescription
runtimeTargetKindRuntimeTargetKindNoDefault main_branch.
targetEnvironmentIdIDNo
targetBranchIdIDNo

Response

Returns ChannelAgentList!. Open the type for its fields and nested types.

FieldTypeDescription
data[ChannelAgent!]!All agents available for the selected runtime target, sorted by name then ID. This complete list is not paginated.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query ChannelAgents($projectReference: ID!, $input: ChannelAgentsInput) {
  channelAgents(projectReference: $projectReference, input: $input) {
    data {
      id
      name
      description
      model
    }
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}