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

# Generate an agent avatar

> `POST /v1/agents/{id}/avatar/generate` - admin-triggered xAI image
generation. The optional `prompt` describes the desired look; it seeds the
subject and is wrapped in the house illustration style + safety rails, then
the image is stored in Trove and set as the agent's `avatar_url`.
Synchronous (a few seconds). The cost is absorbed by the platform
(`provider_usage.paid_by='platform'`). Admin only.



## OpenAPI

````yaml POST /v1/agents/{id}/avatar/generate
openapi: 3.1.0
info:
  title: HQ API
  description: >-
    Public HTTP API for HQ. Authenticate with a Personal Access Token
    (`Authorization: Bearer hq_pat_...`) for server-side integrations, or an
    OAuth 2.1 authorization-code + PKCE flow for browser apps acting on a user's
    behalf. Both grant from the same resource:action scope vocabulary; an
    endpoint's required scope is listed under its `security`.
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 1.0.0
servers:
  - url: https://api.hq.zone
    description: HQ API (production)
security: []
tags:
  - name: me
    description: The signed-in user's own account
  - name: conversations
    description: Conversations and their messages
  - name: documents
    description: The content-addressed documents library
  - name: schedules
    description: Scheduled prompts and recurring tasks
  - name: agents
    description: Agents, their skills and integrations
  - name: memory
    description: What the assistant remembers (L5 governance)
  - name: tokens
    description: Personal Access Token management
  - name: billing
    description: Usage and billing
  - name: notifications
    description: In-app notification center
  - name: admin
    description: Workspace administration
  - name: integrations
    description: Workspace integrations (Slack, MCP, skills)
  - name: onboarding
    description: New-workspace onboarding wizard
  - name: auth
    description: Sign-in, sessions, and OAuth
paths:
  /v1/agents/{id}/avatar/generate:
    post:
      tags:
        - agents
      summary: Generate an agent avatar
      description: >-
        `POST /v1/agents/{id}/avatar/generate` - admin-triggered xAI image

        generation. The optional `prompt` describes the desired look; it seeds
        the

        subject and is wrapped in the house illustration style + safety rails,
        then

        the image is stored in Trove and set as the agent's `avatar_url`.

        Synchronous (a few seconds). The cost is absorbed by the platform

        (`provider_usage.paid_by='platform'`). Admin only.
      operationId: generate_avatar
      parameters:
        - name: id
          in: path
          description: Agent id
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateAvatarReq'
        required: true
      responses:
        '200':
          description: The new avatar URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateAvatarResp'
        '404':
          description: No such agent in this workspace
        '500':
          description: Generation failed (xAI / Trove)
      security:
        - bearer_pat:
            - admin
        - oauth2:
            - admin
components:
  schemas:
    GenerateAvatarReq:
      type: object
      properties:
        prompt:
          type:
            - string
            - 'null'
          description: >-
            Optional free-text look description (e.g. "calm, approachable, soft

            blue palette"). Seeds the SUBJECT only - it's wrapped server-side in

            the house flat-vector illustration style + no-real-likeness /

            no-demographic-marker safety rails, never used as the raw prompt.

            Omitted = the default house style from the agent's name +
            description.
    GenerateAvatarResp:
      type: object
      required:
        - agent_id
        - avatar_url
      properties:
        agent_id:
          type: string
          format: uuid
        avatar_url:
          type: string
  securitySchemes:
    bearer_pat:
      type: http
      scheme: bearer
      bearerFormat: hq_pat
      description: 'Personal Access Token. Send as `Authorization: Bearer hq_pat_...`.'
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hq.zone/v1/oauth/authorize
          tokenUrl: https://api.hq.zone/v1/oauth/token
          refreshUrl: https://api.hq.zone/v1/oauth/token
          scopes:
            admin: Administer the workspace (users, settings, integrations)
            agents:read: View the agents in your workspace
            agents:write: Create and configure agents
            billing:read: View usage and billing information
            conversations:read: Read your conversations and their messages
            conversations:write: Start conversations and send messages on your behalf
            documents:read: Read your documents library
            documents:write: Upload and manage documents in your library
            memory:read: Read what the assistant remembers about you
            memory:write: Correct or delete what the assistant remembers
            schedules:read: View your scheduled tasks
            schedules:write: Create and manage scheduled tasks
            tables:read: Read your tables and their rows
            tables:write: Create tables and add, edit, or delete rows

````