API Docs Browser
Overview
The API Docs Browser provides in-console access to the complete API documentation for the Wuliang AI platform. It features a three-panel layout that lets you browse API interfaces, read detailed documentation, and reference error codes without leaving the console. This is especially useful during development when you need quick access to parameter definitions and response formats.
Prerequisites
- A registered Wuliang AI account
- Logged in to the console
Access the API Docs Browser
In the console sidebar, navigate to Development > API Docs.
The API Docs Browser loads with the three-panel layout.
Interface Layout
The API Docs Browser uses a three-panel layout:
| Panel | Position | Content |
|---|---|---|
| Interface Tree | Left | Grouped list of all API interfaces |
| Content Panels | Right | Overview, Error Codes, or Interface Detail |
Interface Tree
The left panel displays a hierarchical tree of all available API interfaces, organized by capability group:
- Chat - Chat Completions, Messages (Anthropic Compatible)
- Search - Search Completions
- Images - Images Generations
- Embeddings - Embeddings
- Audio - Text-to-Speech, Speech-to-Text
Click a group header to expand or collapse the group.
Click an interface name to open its detailed documentation in the right panel.
Overview Panel
The Overview panel provides a high-level summary of all API capabilities available on the platform.
Click the Overview tab in the right panel area.
Review the summary of each API capability, including brief descriptions and links to detailed documentation.
The overview includes:
| Section | Description |
|---|---|
| Chat Completions | Text generation with multi-turn conversation support |
| Messages | Anthropic-compatible text generation endpoint |
| Search Completions | Web search-augmented text generation |
| Images Generations | Text-to-image generation |
| Embeddings | Text embedding generation for vector representations |
| Audio | Speech synthesis and transcription |
Error Codes Panel
The Error Codes panel lists all global error codes used across the API, organized by HTTP status code.
Click the Error Codes tab in the right panel area.
Browse the error codes table:
HTTP Status Code Description 400 INVALID_PARAMS Invalid request parameters 401 UNAUTHORIZED Invalid or expired API Key 403 FORBIDDEN Access denied 404 MODEL_NOT_FOUND Model not found or offline 429 RATE_LIMIT Rate limit exceeded 500 INTERNAL_ERROR Internal server error 502 UPSTREAM_ERROR Upstream model service error 504 GATEWAY_TIMEOUT Request timeout 
Each error code entry includes the error response format and troubleshooting suggestions.
Interface Detail Panel
The Interface Detail panel shows the full documentation for a specific API interface.
Select an interface from the left panel tree.
The right panel displays the complete documentation for the selected interface:
Documentation Sections
Each interface detail includes the following sections:
Endpoint Information
- HTTP method and URL path
- Brief description of the endpoint
Request Parameters
A table of all request parameters with their type, required status, and description:
| Column | Description |
|---|---|
| Parameter | The parameter name |
| Type | Data type (string, integer, boolean, array, object) |
| Required | Whether the parameter is required |
| Description | Detailed explanation of the parameter |
Request Body
Example request body in JSON format:
Response Format
Example response body in JSON format with field descriptions:
Interface-Specific Error Codes
Error codes specific to this interface, in addition to the global error codes:
Notes
- The API Docs Browser is always accessible within the console, no separate browser tab needed.
- Documentation is updated in real time as new API features are released.
- Use the search functionality in the interface tree to quickly find specific endpoints.
- All code examples can be copied directly from the documentation panels.
Related Documentation
- Make API Calls - Comprehensive guide to calling the API
- API Reference - Full API reference with examples
- Playground - Test API endpoints interactively
- Models & Pricing - Browse available models