---
id: eliza-os-api
title: 'Eliza OS API'
description: 'API documentation for Eliza OS - A flexible and scalable AI agent framework.'
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

import ApiLogo from '@theme/ApiLogo';
import Heading from '@theme/Heading';
import SchemaTabs from '@theme/SchemaTabs';
import TabItem from '@theme/TabItem';
import Export from '@theme/ApiExplorer/Export';

<Heading as={'h1'} className={'openapi__heading'} children={'Eliza OS API'}></Heading>

API documentation for Eliza OS - A flexible and scalable AI agent framework.

This API is designed to be used with a locally running Eliza instance. Endpoints allow for creating,
managing, and interacting with AI agents through a REST interface.

<div
  style={{
    display: 'flex',
    flexDirection: 'column',
    marginBottom: 'var(--ifm-paragraph-margin-bottom)',
  }}
>
  <h3 style={{ marginBottom: '0.25rem' }}>Contact</h3>
  <span>Eliza OS Community:</span>
  <span>URL: [https://github.com/elizaos/eliza](mailto:https://github.com/elizaos/eliza)</span>
</div>