---
id: list-agents
title: 'List all agents'
description: 'Returns a list of all available agents running in the system'
sidebar_label: 'List all agents'
hide_title: true
hide_table_of_contents: true
api: eJylVMtu2zAQ/BViz6ptpOihuhlFUBgI2iCPU5LDmlpJm1CkQq6cuIb+vVjKiZ2kQAtUF0l8zAxnZ7kDwSZBeQPYkJcEdwVUlGzkXjh4KOGCZIg+GTSOk5hQG3TO4AbZ4dqRmfaZOHjPvjHsjbRk0jYJdVBA6CmiQq0qKEEhlhNRAZFSH3yiBOUOThYLfb3lXpo0WEsp1YMzL8uNDV6QM9uRqBdUnSUvCoZ979hm9vl9UsQdJNtSh/ol256ghLC+JytQQB9Vq/CkZ493WIcx4hYKYKEu/X0/V0drkkT2DRRQh9ihQAnDwBW8t/ra8+NAhivywjVTNHWI2c6sBsYCPHb0J+C3QD+wIzXlzVbr+B+PtEcd38Oe7b2ekAx7oVijpXQgMpy0Pp6sUGUkwDgWICxOcXPlV77W0ekpoCNpg0ajoWwiSgslzF/LmShuKGpCdzBEByW0In05n7tg0bUhSfl5sVh8sOBMp01FG3Kh71TZhATjXQGsGvS8e2Gnjn+h+XlpluerD0jL85Wpgh0UJGcpV+V1yyezNLWjZ87N4CuTLE6dsVztPakjdvQU4sPs1t/6q5aTEqlVFSVufHbKrMkMiSrzxNJqsPUAbvvaWBMh+yToLc3Mqa/6wNp66Fx4yqJsJBT2TWFufYcem/ytonKt0OrkRPAiTmsXw9Ao5cXp5dWhqjMoQK2fXFjMTr7Mvu77C23urymMB/e+ha4bPItm6lCrVM7nDUs7rGc2dHPS1SFN7xyPPiTp0B8h5qDla+YlBm9Ksjs0+f9eT/vECz3LvHfIXlOfte/2WTy+GTVuOrLbrTHRdXTjqMOPA8UtlDd3BWwwsvLq31hAS1hRzOF9oK2GyVrqNegbdEPuwfd3lObztSm+n17BOP4Gnqv1EQ==
sidebar_class_name: 'get api-method'
info_path: docs/rest/eliza-os-api
custom_edit_url: null
---

import ApiTabs from '@theme/ApiTabs';
import DiscriminatorTabs from '@theme/DiscriminatorTabs';
import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint';
import SecuritySchemes from '@theme/ApiExplorer/SecuritySchemes';
import MimeTabs from '@theme/MimeTabs';
import ParamsItem from '@theme/ParamsItem';
import ResponseSamples from '@theme/ResponseSamples';
import SchemaItem from '@theme/SchemaItem';
import SchemaTabs from '@theme/SchemaTabs';
import Heading from '@theme/Heading';
import OperationTabs from '@theme/OperationTabs';
import TabItem from '@theme/TabItem';

<Heading as={'h1'} className={'openapi__heading'} children={'List all agents'}></Heading>

<MethodEndpoint method={'get'} path={'/agents'}></MethodEndpoint>

Returns a list of all available agents running in the system

<div>
  <div>
    <ApiTabs label={undefined} id={undefined}>
      <TabItem label={'200'} value={'200'}>
        <div>A successful response containing a list of agents</div>
        <div>
          <MimeTabs className={'openapi-tabs__mime'} schemaType={'response'}>
            <TabItem label={'application/json'} value={'application/json'}>
              <SchemaTabs className={'openapi-tabs__schema'}>
                <TabItem label={'Schema'} value={'Schema'}>
                  <details
                    style={{}}
                    className={'openapi-markdown__details response'}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary style={{}} className={'openapi-markdown__details-summary-response'}>
                      <strong>Schema</strong>
                    </summary>
                    <div style={{ textAlign: 'left', marginLeft: '1rem' }}></div>
                    <ul style={{ marginLeft: '1rem' }}>
                      <SchemaItem collapsible={true} className={'schemaItem'}>
                        <details style={{}} className={'openapi-markdown__details'}>
                          <summary style={{}}>
                            <span className={'openapi-schema__container'}>
                              <strong className={'openapi-schema__property'}>agents</strong>
                              <span className={'openapi-schema__name'}>object[]</span>
                            </span>
                          </summary>
                          <div style={{ marginLeft: '1rem' }}>
                            <li>
                              <div
                                style={{
                                  fontSize: 'var(--ifm-code-font-size)',
                                  opacity: '0.6',
                                  marginLeft: '-.5rem',
                                  paddingBottom: '.5rem',
                                }}
                              >
                                Array [
                              </div>
                            </li>
                            <SchemaItem
                              collapsible={false}
                              name={'id'}
                              required={false}
                              schemaName={'uuid'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'string',
                                format: 'uuid',
                                description: 'Unique identifier for the agent',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'name'}
                              required={false}
                              schemaName={'string'}
                              qualifierMessage={undefined}
                              schema={{ type: 'string', description: 'Name of the agent' }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'clients'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'List of client interfaces the agent is connected to',
                              }}
                            ></SchemaItem>
                            <li>
                              <div
                                style={{
                                  fontSize: 'var(--ifm-code-font-size)',
                                  opacity: '0.6',
                                  marginLeft: '-.5rem',
                                }}
                              >
                                ]
                              </div>
                            </li>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem>
                <TabItem label={'Example (from schema)'} value={'Example (from schema)'}>
                  <ResponseSamples
                    responseExample={
                      '{\n  "agents": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "name": "string",\n      "clients": [\n        "string"\n      ]\n    }\n  ]\n}'
                    }
                    language={'json'}
                  ></ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>