> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List agents

> List agents.

`agentCollection(input: ProjectAgentsInput!): AgentCardList!`

Requires project.agents.read.

## Arguments

| Argument | Type | Required |
| - | - | - |
| `input` | [`ProjectAgentsInput!`](https://veryfront.com/docs/cloud/graphql/types/projectagentsinput) | Yes |

## Input fields

### input

[`ProjectAgentsInput`](https://veryfront.com/docs/cloud/graphql/types/projectagentsinput)

| Field | Type | Required |
| - | - | - |
| `projectReference` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No |
| `sourceTargetKind` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No |
| `runtimeTargetKind` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No |
| `targetEnvironmentId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No |
| `targetBranchId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No |

## Response

Returns [`AgentCardList!`](https://veryfront.com/docs/cloud/graphql/types/agentcardlist). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `data` | [`[ProjectAgentCard!]!`](https://veryfront.com/docs/cloud/graphql/types/projectagentcard) | |
| `diagnostics` | [`[ProjectSourceFileDiagnostic!]!`](https://veryfront.com/docs/cloud/graphql/types/projectsourcefilediagnostic) | Agent source files that could not be read as an agent. Every discovery error is listed here. |

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
query AgentCollection($input: ProjectAgentsInput!) {
  agentCollection(input: $input) {
    data {
      id
      name
      avatarUrl
      canRun
      capabilities
    }
    diagnostics {
      code
      details
      kind
      message
      sourceId
    }
  }
}
```

```json title="variables.json" theme={null}
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}
```

<details>
  <summary>Try this query</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Query

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.