> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/bytedance/deer-flow/llms.txt
> Use this file to discover all available pages before exploring further.
# Gateway API Overview
> Introduction to the DeerFlow Gateway API, authentication, and common patterns
## Introduction
The DeerFlow Gateway API provides RESTful endpoints for managing models, skills, MCP servers, memory, file uploads, and artifacts. It runs as a separate FastAPI service alongside the LangGraph Server.
## Base URL
The API Gateway runs on port `8001` by default:
```
http://localhost:8001
```
All API endpoints are prefixed with `/api`:
```
http://localhost:8001/api/models
http://localhost:8001/api/skills
http://localhost:8001/api/memory
```
## Architecture
The Gateway API is built with FastAPI and provides:
* **Models Management**: Query available AI models and their capabilities
* **Custom Agents**: Create and manage specialized agents with SOUL.md profiles
* **Skills Management**: List, enable/disable, and install custom skills
* **MCP Configuration**: Manage Model Context Protocol server configurations
* **Memory Management**: Access and reload global memory data
* **File Uploads**: Upload files to thread-specific directories
* **Artifacts**: Access and download thread-generated files
LangGraph requests are handled by nginx reverse proxy, while the Gateway provides custom endpoints for configuration and file management.
## Authentication
The Gateway API currently does not require authentication for local development. CORS is handled by nginx in production deployments.
**CORS Origins**: Configurable via `CORS_ORIGINS` environment variable (default: `http://localhost:3000`)
## Configuration
The Gateway can be configured using environment variables:
Host to bind the gateway server
Port to bind the gateway server
Comma-separated list of allowed CORS origins
## Error Handling
The API uses standard HTTP status codes:
Request succeeded
Invalid request parameters or malformed data
Access denied (e.g., path traversal attempt)
Resource not found
Resource already exists (e.g., duplicate skill)
Server error
### Error Response Format
Error responses follow this format:
```json theme={null}
{
"detail": "Error message describing what went wrong"
}
```
## Interactive Documentation
The Gateway API provides interactive documentation:
* **Swagger UI**: `http://localhost:8001/docs`
* **ReDoc**: `http://localhost:8001/redoc`
* **OpenAPI Schema**: `http://localhost:8001/openapi.json`
## Health Check
Check the Gateway service health:
```bash theme={null}
curl http://localhost:8001/health
```
Response:
```json theme={null}
{
"status": "healthy",
"service": "deer-flow-gateway"
}
```
## Next Steps
Query available AI models
Create specialized agents
Manage skills and extensions
Configure MCP servers
Access global memory
Manage file uploads