> ## 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.

# Create agent avatar

> Create agent avatar.

`createAgentAvatar(input: GenerateProjectAgentAvatarInput!): ProjectAgentAvatarUpload!`

Requires project.agents.write.

## Arguments

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

## Input fields

### input

[`GenerateProjectAgentAvatarInput`](https://veryfront.com/docs/cloud/graphql/types/generateprojectagentavatarinput)

| Field | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | |
| `agentId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | |
| `sourceTargetKind` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | |
| `targetBranchId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No | |
| `config` | [`JSON`](https://veryfront.com/docs/cloud/graphql/types/json) | No | |
| `assign` | [`Boolean`](https://veryfront.com/docs/cloud/graphql/types/boolean) | No | Persist the generated avatar\_url onto the agent. Defaults to false; set true to assign it to an existing agent. Default: `false`. |

## Response

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

| Field | Type | Description |
| - | - | - |
| `avatarUrl` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | API upload URL of the generated SVG, stored as a project upload. The agent ID may be existing or prospective; the URL is persisted on the agent only when `assign` is true. |

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}
mutation CreateAgentAvatar($input: GenerateProjectAgentAvatarInput!) {
  createAgentAvatar(input: $input) {
    avatarUrl
  }
}
```

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

<details>
  <summary>Try this mutation</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

  Mutation

  Variables (JSON)
</details>


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