---
description: Complete API reference and command documentation for the AIP SDK.
---

# Reference

## 📚 What's Here

This section contains comprehensive reference documentation for all SDK interfaces:

* **Python SDK API** - Complete Python SDK reference with examples
* **CLI Commands** - All CLI commands, options, and examples
* **REST API** - OpenAPI specification and endpoint documentation

## 🔄 Auto-Generation

### **Python SDK API**

Generated from actual SDK code and docstrings:

* Complete method signatures with type hints
* Parameter descriptions and examples
* Data model definitions
* Error handling patterns
* Working code examples

### **CLI Commands**

Generated from actual CLI structure:

* All available commands and subcommands
* Command options and parameters
* Usage examples and workflows
* Output format options
* Shell completion setup

### **REST API**

Generated from OpenAPI specification:

* Complete endpoint documentation
* Request/response schemas
* Authentication details
* Error codes and handling
* cURL examples

## 📝 Manual Updates

**Reference documentation is now complete and ready for use.**

For future updates:

* **Python SDK**: Update when adding new methods or changing signatures
* **CLI**: Update when adding new commands or changing options
* **REST API**: Update when backend endpoints change

## 🔗 Integration

These reference docs are designed to work with:

* **GitBook**: Ready for immediate import and use
* **CI/CD**: Can be auto-generated on releases
* **Search**: Full-text search across all APIs
* **IDE Integration**: Link to source code

## 📖 How to Use

### **For Developers**

1. **Quick Reference**: Use Python SDK API for method signatures
2. **Command Line**: Use CLI Commands for terminal operations
3. **Direct API**: Use REST API for custom integrations

### **For Operations**

1. **Scripting**: Use CLI Commands with `--view json`
2. **Automation**: Use REST API endpoints directly
3. **Monitoring**: Use health and status endpoints

### **For Integration**

1. **SDK**: Use Python SDK for Python applications
2. **CLI**: Use CLI for shell scripts and CI/CD
3. **REST**: Use REST API for other languages/platforms

## 🔗 Related Documentation

* **Guides** - Task-oriented tutorials
* **Concepts** - Architecture explanations
* **Troubleshooting** - Common issues and solutions

***

_Reference documentation provides complete technical details for all SDK interfaces._
