botserver/docs/src/chapter-10-api/ai-api.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

2025-11-24 13:02:30 -03:00
# AI API
> *⚠️ Note: This API is not yet implemented and is planned for a future release.*
The AI API will provide endpoints for managing AI models, inference, training, and advanced AI operations.
## Planned Features
- Model management and deployment
- Inference endpoints for various AI tasks
- Fine-tuning and training capabilities
- Model versioning and rollback
- Performance optimization settings
- Custom AI pipeline configuration
## Base URL (Planned)
```
http://localhost:8080/api/v1/ai
```
## Authentication
Will use the standard BotServer authentication mechanism with appropriate role-based permissions.
## Endpoints (Planned)
### Model Management
`GET /api/v1/ai/models`
`POST /api/v1/ai/models/deploy`
`DELETE /api/v1/ai/models/{model_id}`
### Inference
`POST /api/v1/ai/inference`
`POST /api/v1/ai/chat/completions`
### Training
`POST /api/v1/ai/training/start`
`GET /api/v1/ai/training/{job_id}/status`
### Model Configuration
`GET /api/v1/ai/models/{model_id}/config`
`PUT /api/v1/ai/models/{model_id}/config`
## Implementation Status
This API is currently in the planning phase. Check back in future releases for availability.