# Aime Chat Docs

> Aime Chat usage and configuration docs with ready-to-run local API scripts. Use when the user asks how Aime Chat features are configured, especially assistant personalities, SOUL.md files, local voices, available model discovery, available Agent discovery, available tool discovery, skill import/management, PTC (Programmatic Tool Calling) in CodeExecution, sending text and images to an idle thread and waiting for its final reply, or listing/reading/searching chat history threads. Includes Python scripts under scripts/ for calling the Aime Chat local API (list models, Agents, tools, preview and import skills, create threads, send thread messages, list running threads, list projects, list/read/search chat history).

- Skill: `darknoah/aime-chat-docs` (Agent Skill, multi-file: 31 files)
- Install (CLI): `npx skillmds@latest add darknoah/aime-chat-docs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/darknoah/aime-chat-docs/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Product & Planning
- Author: DarkNoah (https://skillmd.com/u/darknoah)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/darknoah/aime-chat-docs

---


# Aime Chat Docs

Use this skill when answering questions about Aime Chat configuration and feature conventions.

## Reference Index

- **Assistant personalities**: Read [references/create-personality.md](references/create-personality.md) when explaining how to create or edit an assistant personality, how `SOUL.md` front matter works, or where avatars live.
- **Local voices**: Read [references/create-local-voice.md](references/create-local-voice.md) when explaining how to create local voice folders under user data, what files are required, or how voice IDs are derived.
- **Skill management**: Read [references/manage-skills.md](references/manage-skills.md) when explaining how to create or add Aime Chat skills globally or for the current project.
- **Available models**: Read [references/get-available-models.md](references/get-available-models.md) when explaining how to list configured provider models through the local API server.
- **Available Agents**: Read [references/get-available-agents.md](references/get-available-agents.md) when explaining how to list enabled Agents through the local API server.
- **Agent detail**: Read [references/get-agent.md](references/get-agent.md) when explaining how to fetch a single Agent's full config (instructions, tools, sub-agents, suggestions) by id through the local API server.
- **Create/update Agent**: Read [references/save-agent.md](references/save-agent.md) when explaining how to create a new Agent or update an existing one (name, instructions, tools, model, tags) through the local API server.
- **Available tools**: Read [references/get-available-tools.md](references/get-available-tools.md) when explaining how to list enabled tools through the local API server.
- **Tool detail**: Read [references/get-tool.md](references/get-tool.md) when explaining how to fetch a single tool's detail (sub-tools, input schema, status) by id through the local API server.
- **PTC (Programmatic Tool Calling)**: Read [references/use-ptc.md](references/use-ptc.md) when explaining how to use the CodeExecution PTC mode to call tools programmatically in code, batch tool calls in a loop, call ChatCompletion inside code, or report progress via the Message tool.
- **Create thread**: Read [references/create-thread.md](references/create-thread.md) when explaining how to create a new chat thread (optionally under a project, with an Agent and model) through the local API server.
- **Send thread message**: Read [references/send-thread-message.md](references/send-thread-message.md) when sending text and/or local images to an existing idle thread and waiting for the final assistant text through the local API server.
- **Running threads**: Read [references/list-running-threads.md](references/list-running-threads.md) when explaining how to list threads that are currently streaming (running) through the local API server.
- **Projects**: Read [references/list-projects.md](references/list-projects.md) when explaining how to list projects (with pagination and title filter) through the local API server.
- **Chat history**: Read [references/chat-history.md](references/chat-history.md) when explaining how to list recent chat threads, read a thread's messages, or keyword-search across chat history through the local API server.

## API Scripts

The `scripts/` folder contains standalone Python scripts (standard library only, Python 3) for the Aime Chat local API. All scripts read the API base URL from the `AIME_CHAT_API_BASE_URL` environment variable and require the local API server to be enabled and running. Prefer running these scripts over hand-writing HTTP requests.

- **[scripts/get_available_models.py](scripts/get_available_models.py)**: List configured provider models. Supports `--type` (`llm`, `embedding`, `reranker`, `image_generation`, `transcription`, `speech`, `ocr`, `music`) and `--json` for raw output.
- **[scripts/get_available_agents.py](scripts/get_available_agents.py)**: List enabled Agents as `- [<agent-id>]: <description>`. Supports `--visible-only` to exclude hidden Agents and `--json` for raw output.
- **[scripts/get_agent.py](scripts/get_agent.py)**: Get a single Agent's full config by id, e.g. `python scripts/get_agent.py --id code-agent`. Shows type, description, tools, sub-agents, suggestions, and instructions. Supports `--json` for raw output.
- **[scripts/save_agent.py](scripts/save_agent.py)**: Create or update an Agent (always saved as active). Requires `--id` (letters/digits/-/_ only), `--name`, `--description`, `--instructions`. Optional repeatable `--suggestion`, `--tool`, and `--sub-agent`.
- **[scripts/get_available_tools.py](scripts/get_available_tools.py)**: List enabled tools grouped by type (`mcp`, `build-in`, `skill`), expanding toolkit sub-tools. Descriptions are truncated to the first 100 characters. Supports `--json` for raw output.
- **[scripts/get_tool.py](scripts/get_tool.py)**: Get a single tool's detail by id, e.g. `python scripts/get_tool.py --id skill:local:xlsx`. Shows type, status, description, and sub-tools. Supports `--json` for raw output.
- **[scripts/preview_git_skill.py](scripts/preview_git_skill.py)**: Preview the skills available in a git repository, e.g. `python scripts/preview_git_skill.py https://github.com/<owner>/<repo>`.
- **[scripts/import_skills.py](scripts/import_skills.py)**: Import skills globally or into the current project. Use `--repo-or-url` with optional repeatable `--skill` for repo installs, `--file` for `.skill`/`.zip` packages, and `--path <cwd>` for project-scoped installs (omit `--path` for global).
- **[scripts/create_thread.py](scripts/create_thread.py)**: Create a new chat thread. Optional `--project-id`, `--agent-id`, `--model`, and `--json` for raw output.
- **[scripts/send_thread_message.py](scripts/send_thread_message.py)**: Send text and/or repeatable local `--image` files to an existing idle thread through the existing `chat()` API. Waits for `chat()` to finish, then prints text from the last returned message. Throws an error instead of queueing when the thread is busy.
- **[scripts/list_running_threads.py](scripts/list_running_threads.py)**: List currently running (streaming) threads. Supports `--json` for raw output.
- **[scripts/list_projects.py](scripts/list_projects.py)**: List projects. Optional `--filter`, `--page`, `--size`, and `--json` for raw output.
- **[scripts/chat_history_list.py](scripts/chat_history_list.py)**: List recent chat threads (normal and project threads grouped by project). Optional `--since`, `--until`, `--limit`, and `--include-cron` (cron-created threads are excluded by default).
- **[scripts/chat_history_read.py](scripts/chat_history_read.py)**: Read messages of a single thread by `--thread-id` (thread meta + plain-text messages). Optional `--limit`, `--since` for delta reads, and `--include-tools` for tool-call summaries.
- **[scripts/chat_history_search.py](scripts/chat_history_search.py)**: Keyword search across recent chat threads with `--query` (space-separated keywords are fuzzy-matched, all must appear), matching message content, thread titles and project names. Excerpts are grouped per thread with project info (if any), thread id and title. Optional `--since`, `--limit`, and `--thread-limit`.

The skills directory can be located via the `AIME_CHAT_SKILL_PATH` environment variable, so scripts can be run from anywhere as `python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/<script>.py"`.

Example:

```bash
python scripts/get_available_models.py --type embedding
python scripts/import_skills.py --repo-or-url https://github.com/resciencelab/opc-skills --skill skills/reddit --path "$PWD"
python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/create_thread.py" --project-id <project-id>
python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/send_thread_message.py" --thread-id <thread-id> --text "请总结当前进度" --image ./screenshot.png
python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/list_running_threads.py"
python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/list_projects.py" --filter my
python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/chat_history_list.py" --since 2026-07-20
python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/chat_history_read.py" --thread-id <thread-id>
python "${AIME_CHAT_SKILL_PATH}/aime-chat-docs/scripts/chat_history_search.py" --query "关键词"
```

