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

# List Agents

> API key permission: Agents (Admin also opens it).



## OpenAPI

````yaml /api-reference/openapi.json get /agents/list
openapi: 3.1.0
info:
  title: Neural Factory API
  version: 0.1.0
  description: >-
    The endpoints a program can call with an API key. Exchange the key's secret
    for a token at POST /apikeys/token and send it as a Bearer token.
servers:
  - url: https://api.neuralfactory.ai
    description: SaaS
  - url: https://{apiHost}
    description: 'Enterprise: the API address of your own deployment'
    variables:
      apiHost:
        default: api.example.com
        description: Your deployment's API host
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Chat
  - name: Runs
  - name: Agents
  - name: Workflows
  - name: Schedules
  - name: Knowledge bases
  - name: Documents
  - name: Search
  - name: Skills
  - name: Toolkits
  - name: Files
  - name: Interactions
  - name: Usage and billing
  - name: Catalogue
  - name: Browser
  - name: Users
  - name: Groups
  - name: Builds
paths:
  /agents/list:
    get:
      tags:
        - Agents
      summary: List Agents
      description: 'API key permission: Agents (Admin also opens it).'
      operationId: list_agents_agents_list_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number, starting from 1
            default: 1
            title: Page
          description: Page number, starting from 1
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of items per page
            default: 20
            title: Page Size
          description: Number of items per page
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Search by title or description
            title: Search
          description: Search by title or description
        - name: agent_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'Filter by agent type: ''agent'', ''subagent'', or None for all'
            title: Agent Type
          description: 'Filter by agent type: ''agent'', ''subagent'', or None for all'
        - name: tags
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated tag values to filter by (OR logic)
            title: Tags
          description: Comma-separated tag values to filter by (OR logic)
        - name: favourites_only
          in: query
          required: false
          schema:
            type: boolean
            description: Return only agents favourited by the current user
            default: false
            title: Favourites Only
          description: Return only agents favourited by the current user
        - name: published_only
          in: query
          required: false
          schema:
            type: boolean
            description: Leave out agents that were never published
            default: false
            title: Published Only
          description: Leave out agents that were never published
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Field to sort by (title, description, model, createdByEmail,
              knowledgeBases, tools, version, createdAt)
            title: Sort By
          description: >-
            Field to sort by (title, description, model, createdByEmail,
            knowledgeBases, tools, version, createdAt)
        - name: sort_order
          in: query
          required: false
          schema:
            type: string
            description: 'Sort order: asc or desc'
            default: desc
            title: Sort Order
          description: 'Sort order: asc or desc'
        - name: env
          in: query
          required: false
          schema:
            title: Env
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AgentList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AgentEntry'
          type: array
          title: Items
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      type: object
      required:
        - items
        - meta
      title: AgentList
      description: Paginated agents list response
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentEntry:
      properties:
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        knowledge_bases:
          items:
            type: string
          type: array
          title: Knowledge Bases
        prompt:
          type: string
          title: Prompt
        tags:
          items:
            type: string
          type: array
          title: Tags
          default: []
        model:
          type: string
          title: Model
        allowed_groups:
          items:
            type: string
          type: array
          title: Allowed Groups
          default: []
        allowed_user_ids:
          items:
            type: string
          type: array
          title: Allowed User Ids
          default: []
        visibility:
          type: string
          title: Visibility
          default: private
        strict_mode:
          type: boolean
          title: Strict Mode
          default: false
        strict_mode_message:
          type: string
          title: Strict Mode Message
          default: ''
        show_citations:
          type: boolean
          title: Show Citations
          default: false
        core_tools:
          items:
            type: string
          type: array
          title: Core Tools
          default:
            - web_search
            - knowledge_search
            - code_execution
            - file_editor
            - browser_automation
            - browser_control
            - image_generation
        toolkits:
          items:
            $ref: '#/components/schemas/ToolkitSelection'
          type: array
          title: Toolkits
          default: []
        workflows:
          items:
            $ref: '#/components/schemas/WorkflowSelection'
          type: array
          title: Workflows
          default: []
        agent_type:
          type: string
          enum:
            - agent
            - subagent
          title: Agent Type
          default: agent
        subagents:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Subagents
        workflow_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Workflow Config
        skills:
          items:
            type: string
          type: array
          title: Skills
          default: []
        guardrails:
          anyOf:
            - $ref: '#/components/schemas/Guardrails'
            - type: 'null'
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
        id:
          type: string
          title: Id
        knowledge_base_details:
          items:
            $ref: '#/components/schemas/api__agents__models__KnowledgeBaseDetail'
          type: array
          title: Knowledge Base Details
          default: []
        avatar:
          type: string
          title: Avatar
          default: ''
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
        created_by_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By Email
        created_by_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By Name
        is_favourite:
          type: boolean
          title: Is Favourite
          default: false
        current_version_number:
          type: integer
          title: Current Version Number
          default: 0
        published_revision:
          anyOf:
            - type: integer
            - type: 'null'
          title: Published Revision
        next_revision:
          anyOf:
            - type: integer
            - type: 'null'
          title: Next Revision
        draft:
          anyOf:
            - $ref: '#/components/schemas/AgentDraft'
            - type: 'null'
        has_draft:
          type: boolean
          title: Has Draft
          default: false
        from_use_case:
          anyOf:
            - $ref: '#/components/schemas/FromUseCase'
            - type: 'null'
        subagent_info:
          items:
            $ref: '#/components/schemas/SubAgentInfo'
          type: array
          title: Subagent Info
        subagent_details:
          items:
            $ref: '#/components/schemas/SubagentDetail'
          type: array
          title: Subagent Details
        skill_details:
          items:
            $ref: '#/components/schemas/SkillDetail'
          type: array
          title: Skill Details
      type: object
      required:
        - title
        - description
        - knowledge_bases
        - prompt
        - model
        - id
      title: AgentEntry
    PaginationMeta:
      properties:
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - total
        - page
        - page_size
        - total_pages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ToolkitSelection:
      properties:
        toolkit_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Toolkit Id
        name:
          type: string
          title: Name
        selectedTools:
          items:
            type: string
          type: array
          title: Selectedtools
          default: []
      type: object
      required:
        - name
      title: ToolkitSelection
    WorkflowSelection:
      properties:
        workflow_id:
          type: string
          title: Workflow Id
        name:
          type: string
          title: Name
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
          default: published
      type: object
      required:
        - workflow_id
        - name
      title: WorkflowSelection
      description: >-
        A deterministic workflow this agent may run as a tool. ``version``
        selects

        which revision to execute ('published' by default).
    Guardrails:
      properties:
        scope:
          type: string
          title: Scope
          default: ''
        cite_sources:
          type: boolean
          title: Cite Sources
          default: true
        hand_off:
          anyOf:
            - type: string
            - type: 'null'
          title: Hand Off
        approval_before:
          anyOf:
            - type: string
            - type: 'null'
          title: Approval Before
        language:
          type: string
          title: Language
          default: match the question
        knowledge_only:
          type: boolean
          title: Knowledge Only
          default: false
      type: object
      title: Guardrails
    api__agents__models__KnowledgeBaseDetail:
      properties:
        id:
          type: string
          title: Id
        title:
          type: string
          title: Title
        title_slug:
          type: string
          title: Title Slug
          default: ''
        description:
          type: string
          title: Description
          default: ''
      type: object
      required:
        - id
        - title
      title: KnowledgeBaseDetail
    AgentDraft:
      properties:
        spec:
          $ref: '#/components/schemas/AgentSpec'
        revision:
          type: integer
          title: Revision
        updated_at:
          type: string
          format: date-time
          title: Updated At
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated By
      type: object
      required:
        - spec
        - revision
        - updated_at
      title: AgentDraft
      description: The unpublished working copy of an agent.
    FromUseCase:
      properties:
        id:
          type: string
          title: Id
        version:
          type: integer
          title: Version
      type: object
      required:
        - id
        - version
      title: FromUseCase
      description: >-
        The use case an agent or a workflow was activated from, and the artifact
        version copied.
    SubAgentInfo:
      properties:
        name:
          type: string
          title: Name
        agent_type:
          type: string
          title: Agent Type
        description:
          type: string
          title: Description
        capabilities:
          items:
            type: string
          type: array
          title: Capabilities
        status:
          type: string
          title: Status
          default: ready
      type: object
      required:
        - name
        - agent_type
        - description
        - capabilities
      title: SubAgentInfo
      description: Information about a sub-agent instance
    SubagentDetail:
      properties:
        id:
          type: string
          title: Id
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
          default: ''
        model:
          type: string
          title: Model
          default: ''
        toolkits:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Toolkits
        avatar:
          type: string
          title: Avatar
          default: ''
      type: object
      required:
        - id
        - title
      title: SubagentDetail
      description: Detailed information about a subagent
    SkillDetail:
      properties:
        id:
          type: string
          title: Id
        display_name:
          type: string
          title: Display Name
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
      type: object
      required:
        - id
        - display_name
        - name
        - description
      title: SkillDetail
      description: Skill metadata for agent response.
    AgentSpec:
      properties:
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        knowledge_bases:
          items:
            type: string
          type: array
          title: Knowledge Bases
        prompt:
          type: string
          title: Prompt
        tags:
          items:
            type: string
          type: array
          title: Tags
          default: []
        model:
          type: string
          title: Model
        allowed_groups:
          items:
            type: string
          type: array
          title: Allowed Groups
          default: []
        allowed_user_ids:
          items:
            type: string
          type: array
          title: Allowed User Ids
          default: []
        visibility:
          type: string
          title: Visibility
          default: private
        strict_mode:
          type: boolean
          title: Strict Mode
          default: false
        strict_mode_message:
          type: string
          title: Strict Mode Message
          default: ''
        show_citations:
          type: boolean
          title: Show Citations
          default: false
        core_tools:
          items:
            type: string
          type: array
          title: Core Tools
          default:
            - web_search
            - knowledge_search
            - code_execution
            - file_editor
            - browser_automation
            - browser_control
            - image_generation
        toolkits:
          items:
            $ref: '#/components/schemas/ToolkitSelection'
          type: array
          title: Toolkits
          default: []
        workflows:
          items:
            $ref: '#/components/schemas/WorkflowSelection'
          type: array
          title: Workflows
          default: []
        agent_type:
          type: string
          enum:
            - agent
            - subagent
          title: Agent Type
          default: agent
        subagents:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Subagents
        workflow_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Workflow Config
        skills:
          items:
            type: string
          type: array
          title: Skills
          default: []
        guardrails:
          $ref: '#/components/schemas/Guardrails'
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
        rationale:
          additionalProperties:
            type: string
          type: object
          title: Rationale
      type: object
      required:
        - title
        - description
        - knowledge_bases
        - prompt
        - model
      title: AgentSpec
      description: >-
        An agent as the builder shapes it: the configuration plus guardrails and

        the reasons behind each section. The runtime switches the guardrails
        imply

        are derived here so the document and the guardrails never disagree.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The access_token returned by POST /apikeys/token for an API key's
        secret.

````

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