List agents a runtime target can use - Veryfront

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

Requires project.channels.read.

Arguments

Argument	Type	Required	Description
`projectReference`	`ID!`	Yes	Project UUID or slug.
`input`	`ChannelAgentsInput`	No

Input fields

input

ChannelAgentsInput

Field	Type	Required	Description
`runtimeTargetKind`	`RuntimeTargetKind`	No	Default main_branch.
`targetEnvironmentId`	`ID`	No
`targetBranchId`	`ID`	No

Response

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

Field	Type	Description
`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

query ChannelAgents($projectReference: ID!, $input: ChannelAgentsInput) {
  channelAgents(projectReference: $projectReference, input: $input) {
    data {
      id
      name
      description
      model
    }
  }
}

{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}