# Documentation Overview

This file is the focused AI-readable context for one UniAll documentation page.

URL: https://docs.uniall.ai/
Locale: en
Markdown: https://docs.uniall.ai/ai/pages/index.md
Description: UniAll developer documentation scope, API style, and selected model documentation structure.

Agent guidance:
- Use this page when the user is asking about this specific route or model capability.
- Preserve endpoint paths, JSON keys, model IDs, and placeholder values exactly.
- Treat examples such as `sk-***`, `{BASE_URL}`, and `task_xxx` as safe placeholders, not real secrets.

## Page Markdown

UniAll Docs is the developer reference for the selected API and model pages migrated from the current Apifox documentation scope. The source menu is used as an inventory only. The new site normalizes naming, routes, examples, and page structure so the docs read as one UniAll product surface.

The current public documentation is intentionally narrow. It includes the selected balance, model listing, image, video, audio, and digital-human pages from the approved scope. Standalone quick start, authentication, billing policy, error-code catalog, changelog, and generated API reference pages are not part of this phase.

## Included Documentation

| Area | Current pages | Main purpose |
| --- | --- | --- |
| Account | [Query Balance](/balance) | Confirm account and API key quota before submitting tasks. |
| Model index | [Models](/models) | List model documentation by capability and describe the model-list endpoint. |
| Image generation | [Async Image Generation](/models/image/async-image-generation), Seedream, GPT-Image-2, Nano Series | Use async tasks or synchronous image endpoints depending on the model page. |
| Video generation | Happy-Horse, Seedance 2.0, [Grok Imagine](/models/video/grok-imagine), Veo 3.1, Vidu, Kling, Wan 2.6, Sora 2 | Submit video tasks, poll status, and retrieve completed videos. |
| Audio and music | Music Generation, Speech Synthesis | Generate music or speech with model-specific request fields. |
| Digital humans | Digital Human Video | Generate narrated digital-human videos. |

## API Style

Most model pages use a task-based flow:

1. Submit a task with `Authorization: Bearer sk-***`.
2. Store the returned task ID.
3. Poll the task endpoint every 2 to 5 seconds.
4. Stop polling when the task reaches a terminal status such as `succeeded`, `completed`, or `failed`.
5. Use the returned result URL or content endpoint to download the final asset.

Balance and model listing pages are synchronous API concept pages. They return immediately and do not require polling.

## Common Conventions

| Convention | Rule |
| --- | --- |
| Base URL | Examples use `{BASE_URL}` as a placeholder. |
| Authentication | Use `Authorization: Bearer sk-***` unless a page documents a compatibility-specific header. |
| Request examples | `curl` is the primary example format. |
| Model IDs | Use exact model IDs in JSON, such as `grok-imagine` and `gpt-image-2`. |
| Result URLs | Treat returned URLs as generated assets; do not assume they are permanent unless the product contract says so. |
| Billing | Page-level billing notes explain what affects cost, but exact prices should come from the current product pricing surface. |

## Language And AI-Readable Docs

English is the default locale at `/`. Chinese is available under `/zh-CN/`. Code examples, JSON keys, endpoint paths, and model IDs stay identical across languages.

The site also publishes AI-readable indexes:

- [`/llms.txt`](/llms.txt)
- [`/llms-full.txt`](/llms-full.txt)

Use these files when an agent or external AI tool needs a compact view of the current documentation surface.

## Related Pages

- [Query Balance](/balance)
- [Models](/models)
- [Async Image Generation](/models/image/async-image-generation)
- [Grok Imagine Video Generation](/models/video/grok-imagine)