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

# Get agent icon

> Retrieve the icon for an agent as a WebP image file. Access control: Sys-admin users can access icons for all agents from all companies. Company admin users can access icons for all agents from their company. Regular users can only access icons for agents linked to groups they belong to.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/agents/{id}/icon
openapi: 3.1.0
info:
  title: LightOn API
  version: 3.15.0 (v3)
  description: >-
    LightOn gives you an API to search, parse, and ingest documents at scale.
    Build knowledge-retrieval pipelines without managing vector databases or OCR
    models.
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Facets
    description: Operations about facets
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Files Processing
    description: Operations about files processing
  - name: Users
    description: Operations about users
  - name: API Keys
    description: Operations about API keys
  - name: User Groups
    description: Operations about user groups
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/agents/{id}/icon:
    get:
      tags:
        - Agents
      summary: Get agent icon
      description: >-
        Retrieve the icon for an agent as a WebP image file. Access control:
        Sys-admin users can access icons for all agents from all companies.
        Company admin users can access icons for all agents from their company.
        Regular users can only access icons for agents linked to groups they
        belong to.
      operationId: api_v3_agents_icon_retrieve
      parameters:
        - in: query
          name: download
          schema:
            type: string
          description: Set to 'true' to download the icon as an attachment
        - in: path
          name: id
          schema:
            type: integer
          description: ID of the agent
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
                format: binary
                description: WebP image file content
          description: ''
        '404':
          content:
            application/json:
              schema:
                description: Agent or icon not found
          description: ''
        '503':
          description: >-
            API is under maintenance. Check `GET /api/v3/system/status` for
            active periods and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceMaintenance503'
      security:
        - bearerAuth: []
components:
  schemas:
    ServiceMaintenance503:
      type: object
      description: >-
        Returned by the maintenance middleware when the requested endpoint is
        blocked.
      required:
        - detail
        - error
        - mode
      properties:
        detail:
          type: string
          example: System is under maintenance.
        error:
          type: string
          example: service_maintenance
        mode:
          type: string
          enum:
            - full_shutdown
            - warning_banner
          description: >-
            `full_shutdown` blocks all traffic; `warning_banner` also blocks and
            shows a dismissible toast.
        reason:
          type: string
          description: Operator-supplied maintenance reason, if any.
        started_at:
          type: string
          format: date-time
        endpoint_category_names:
          type: array
          items:
            type: string
          description: >-
            Non-empty only for category-scoped periods. Empty means all
            endpoints are affected.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````

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