Create agent avatar

createAgentAvatar(input: GenerateProjectAgentAvatarInput!): ProjectAgentAvatarUpload!

Requires project.agents.write.

Arguments

ArgumentTypeRequired
inputGenerateProjectAgentAvatarInput!Yes

Input fields

input

GenerateProjectAgentAvatarInput

FieldTypeRequiredDescription
projectReferenceStringNo
agentIdID!Yes
sourceTargetKindStringNo
targetBranchIdIDNo
configJSONNo
assignBooleanNoPersist the generated avatar_url onto the agent. Defaults to false; set true to assign it to an existing agent. Default: false.

Response

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

FieldTypeDescription
avatarUrlString!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 lists all published input and response types.

Example

graphql
mutation CreateAgentAvatar($input: GenerateProjectAgentAvatarInput!) {
  createAgentAvatar(input: $input) {
    avatarUrl
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "agentId": "00000000-0000-4000-8000-000000000001"
  }
}