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

# Create agent favorite

> Favorite an agent for the current user.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml post /api/v3/agents/favorites
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/favorites:
    post:
      tags:
        - Agents
      summary: Create agent favorite
      description: Favorite an agent for the current user.
      operationId: api_v3_agents_favorites_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentFavoriteRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateAgentFavoriteRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateAgentFavoriteRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentFavoriteSchema'
          description: ''
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentFavoriteSchema'
          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:
    CreateAgentFavoriteRequest:
      type: object
      properties:
        agent_id:
          type: integer
      required:
        - agent_id
    AgentFavoriteSchema:
      type: object
      properties:
        id:
          type: integer
        agent_name:
          type: string
        agent_description:
          type:
            - string
            - 'null'
        agent_id:
          type: integer
        user_id:
          type: integer
      required:
        - agent_description
        - agent_id
        - agent_name
        - id
        - user_id
    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.

````