---
id: get-agent
title: 'Get agent details'
description: 'Returns detailed information about a specific agent'
sidebar_label: 'Get agent details'
hide_title: true
hide_table_of_contents: true
api: eJytVk1v2zgQ/SvEXLYFVNvodg+rm9E1CqPFbpCkp9iHsTiW2FCkQo6ceA3998VQshPXbtpt6oskk/PefM/sgLGMkN8AluQ4wjIDTbEIpmHjHeRwSdwGF5UmRmNJK+PWPtQoxwpXvmWFKjZUmLUpVEKBDHxDIV2Za8ihJJ4OBw0GrIkpCOkOHNYEeU8+15CBEc4GuYIMAt21JpCGnENLGcSiohoh3wFvGxGLHIwrIYNeI8ihbY2G7msb5n8pv1ZcUa+fYq8CcTC0IeiWQhQb7yJFwX47mcjjGOGqLQqKcd1atb+s7g1XA2DvnAgZFN6xWJrvAJvGmiJ5YfwlCszu1AS/+kJFckwQn7HplTD6h8wsKgxYMIVziI/uu+n9vPwZlq99+dmZu5aU0eTYrA0FtfYh+fZRmS4bAnsKfgz2N9a0D82ReO012YvgN0YfGfcNnOuKVBJRzSAjMW4jqVc0KkeZWkhGOjQLkHd0XAXfmGIBr4VtZfz3Oa4qH1itjC8DNtX2rNrWh6dWYwi4laRmquMpw0mezh6YnCatBEeh02qFxW0ZfOuO6i55iGLEkmYPWDeW4otYE4QaEGMK6MEsxQGNGwQbH/kXMgrcc3QsMXoJ0XUCOI6TMlHdOn9vSZeEK0t9FxNh1FI6ZvMi4y4oRO/QGt4mYzieTZWDCi+g+rjHUCuMdL4QG9uWxr3IoB5Bykmr1faUIhKzcWU814SOod7vxd4cJsZBWIB4a+l/oPwWVeHrunVDm1U9gCBtI1P9A0Wd7knXqBs+50DJQsOi1SMtdOmXwbvJu9NRkSadcl7gWqd/3UygEPzZXkh9OZ3h7vaa1sSVH0ZxmsJcQQ7jfuiPd8P87UCCGTb76dwGCzlUzE0+HltfoK185Pz3yWRy4slPcqw0bcj6phY1eqQ0YKV3Jc0HV86s+RfVP1dqejE/QZpezJX2RSsgfVglLgeRN2qq1pYeTCpdp1Us0KY6ns6HcbyWHePeh9vRwi3cdWWiEEnha4qmdKRlPKyoT+l+jqtkn92q0DrpPwOhcZHRFTRSM6cbbxxHhdb6+75tBULJ3kwtXI0Oy/SOqVszSbYIUiLYKyfdKPi2FMrL2dV1f3ONBY0gA3F974XJ6O0foz+H7MEiZc+wLR1c8b5PfpZqfoxVzMfj0nDVrkaFr8ckt33snymhpe3W6J4gfiA+2WSOgrJ7TOKf3AiHpGV64HFj0aQhlpTeDel42EEzyPcL4TIDSTk53O2kyX0Otuvk77uWwhbym2UGGwxGEiDlrDZR3jXka7SRnrHj1eWwIL1Wzy2I31B930ydOH+DtpUvyOCWtk8W2m7ZZVARpi3mZjecTouCGn4id9IWpGgONfthdg1d9x8cBRBS
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={'Get agent details'}></Heading>

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

Returns detailed information about a specific agent

<Heading
  id={'request'}
  as={'h2'}
  className={'openapi-tabs__heading'}
  children={'Request'}
></Heading>

<details
  style={{ marginBottom: '1rem' }}
  className={'openapi-markdown__details'}
  data-collapsed={false}
  open={true}
>
  <summary style={{}}>
    <h3 className={'openapi-markdown__details-summary-header-params'}>Path Parameters</h3>
  </summary>
  <div>
    <ul>
      <ParamsItem
        className={'paramsItem'}
        param={{
          name: 'agentId',
          in: 'path',
          required: true,
          schema: { type: 'string', format: 'uuid' },
          description: 'ID of the agent to retrieve',
        }}
      ></ParamsItem>
    </ul>
  </div>
</details>
<div>
  <div>
    <ApiTabs label={undefined} id={undefined}>
      <TabItem label={'200'} value={'200'}>
        <div>Successful response with agent details</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={false}
                        name={'id'}
                        required={false}
                        schemaName={'uuid'}
                        qualifierMessage={undefined}
                        schema={{ type: 'string', format: 'uuid' }}
                      ></SchemaItem>
                      <SchemaItem collapsible={true} className={'schemaItem'}>
                        <details style={{}} className={'openapi-markdown__details'}>
                          <summary style={{}}>
                            <span className={'openapi-schema__container'}>
                              <strong className={'openapi-schema__property'}>character</strong>
                              <span className={'openapi-schema__name'}>object</span>
                            </span>
                          </summary>
                          <div style={{ marginLeft: '1rem' }}>
                            <SchemaItem
                              collapsible={false}
                              name={'id'}
                              required={false}
                              schemaName={'uuid'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'string',
                                format: 'uuid',
                                description: 'Unique identifier for the character',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'name'}
                              required={true}
                              schemaName={'string'}
                              qualifierMessage={undefined}
                              schema={{ type: 'string', description: 'Name of the character' }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'modelProvider'}
                              required={false}
                              schemaName={'string'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'string',
                                description:
                                  'The model provider to use (e.g., "openai", "anthropic")',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'bio'}
                              required={false}
                              schemaName={'string'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'string',
                                description: 'Short biography of the character',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'lore'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'Extended lore and background information',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'messageExamples'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'Example messages for character training',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'postExamples'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'Example posts for character training',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'topics'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'Topics the character is knowledgeable about',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'adjectives'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'Personality traits of the character',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'knowledge'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'Knowledge base for the character',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'plugins'}
                              required={false}
                              schemaName={'string[]'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'array',
                                items: { type: 'string' },
                                description: 'Plugins used by the character',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'settings'}
                              required={false}
                              schemaName={'object'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'object',
                                description: 'Character-specific settings',
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'style'}
                              required={false}
                              schemaName={'object'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'object',
                                description: "Character's communication style",
                              }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={'system'}
                              required={false}
                              schemaName={'string'}
                              qualifierMessage={undefined}
                              schema={{
                                type: 'string',
                                description: 'System prompt for the character',
                              }}
                            ></SchemaItem>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem>
                <TabItem label={'Example (from schema)'} value={'Example (from schema)'}>
                  <ResponseSamples
                    responseExample={
                      '{\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "character": {\n    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n    "name": "string",\n    "modelProvider": "string",\n    "bio": "string",\n    "lore": [\n      "string"\n    ],\n    "messageExamples": [\n      "string"\n    ],\n    "postExamples": [\n      "string"\n    ],\n    "topics": [\n      "string"\n    ],\n    "adjectives": [\n      "string"\n    ],\n    "knowledge": [\n      "string"\n    ],\n    "plugins": [\n      "string"\n    ],\n    "settings": {},\n    "style": {},\n    "system": "string"\n  }\n}'
                    }
                    language={'json'}
                  ></ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
      <TabItem label={'404'} value={'404'}>
        <div>Agent not found</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={false}
                        name={'error'}
                        required={false}
                        schemaName={'string'}
                        qualifierMessage={undefined}
                        schema={{ type: 'string', example: 'Agent not found' }}
                      ></SchemaItem>
                    </ul>
                  </details>
                </TabItem>
                <TabItem label={'Example (from schema)'} value={'Example (from schema)'}>
                  <ResponseSamples
                    responseExample={'{\n  "error": "Agent not found"\n}'}
                    language={'json'}
                  ></ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>