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

# API Reference

> ARKOS API endpoints for agent interaction and management

## Overview

ARKOS provides an OpenAI-compatible API interface for interacting with intelligent agents. The API is built with FastAPI and provides endpoints for chat completions, agent management, and memory operations.

<Note>
  The full API implementation is currently under development. The OpenAI compatibility layer is functional in `base_module/app.py`.
</Note>

## Base URL

```
http://localhost:1111
```

## Authentication

**Coming soon!** Authentication and API key management will be implemented in a future release.

## Available Endpoints

### Chat Completions

The chat completions endpoint provides OpenAI-compatible chat interactions:

* **POST** `/v1/chat/completions` - Send messages to the agent

<Card title="OpenAI Compatibility" icon="robot">
  ARKOS implements the OpenAI chat completions API format for easy integration
</Card>

## Planned Endpoints

The following endpoints are planned for future releases:

### Agent Management

* **Coming soon!** Create, list, update, and delete agents
* **Coming soon!** Configure agent behaviors and state machines

### Memory Operations

* **Coming soon!** Store and retrieve memories
* **Coming soon!** Search semantic memory
* **Coming soon!** Memory consolidation controls

### Tool Integration

* **Coming soon!** Register MCP tools
* **Coming soon!** Execute tool functions
* **Coming soon!** Tool discovery and management

### System Configuration

* **Coming soon!** Model selection and configuration
* **Coming soon!** System health and metrics
* **Coming soon!** Log access and debugging