api_xai 0.3.0

X.AI Grok API client for accessing large language models (LLMs).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

# XAI API Endpoints Summary

**Source:** Official OpenAPI 3.0.3 Specification
**Base URL:** `https://api.x.ai`
**Authentication:** Bearer token (Authorization header)

---

## Core Endpoints by Category

### 🔑 API Key Management

| Method | Endpoint | Description | Compatibility |
|--------|----------|-------------|---------------|
| GET | `/v1/api-key` | Get API key info (name, status, permissions) | XAI-specific |

### 💬 Chat & Completions

| Method | Endpoint | Description | Compatibility |
|--------|----------|-------------|---------------|
| POST | `/v1/chat/completions` | Chat completions (primary) | OpenAI ✅ |
| POST | `/v1/completions` | Text completions (legacy) | OpenAI ✅ |
| POST | `/v1/complete` | Complete endpoint | Anthropic ✅ |
| POST | `/v1/messages` | Messages endpoint | Anthropic ✅ |

### 🤖 Models

| Method | Endpoint | Description | Compatibility |
|--------|----------|-------------|---------------|
| GET | `/v1/models` | List all models | OpenAI ✅ |
| GET | `/v1/models/{model_id}` | Get specific model | OpenAI ✅ |
| GET | `/v1/language-models` | List language models (detailed) | XAI-specific |
| GET | `/v1/language-models/{model_id}` | Get language model (detailed) | XAI-specific |

### 🔢 Embeddings

| Method | Endpoint | Description | Compatibility |
|--------|----------|-------------|---------------|
| POST | `/v1/embeddings` | Create embeddings | OpenAI ✅ |
| GET | `/v1/embedding-models` | List embedding models | XAI-specific |
| GET | `/v1/embedding-models/{model_id}` | Get embedding model | XAI-specific |

---

## Implementation Priority

### Phase 1: MVP (Essential)
1. `POST /v1/chat/completions` - Primary chat endpoint
2. `GET /v1/models` - Model listing
3. `GET /v1/models/{model_id}` - Model details

### Phase 2: Enhanced (Recommended)
4. `POST /v1/embeddings` - Embeddings support
5. `GET /v1/language-models` - Detailed model info
6. `POST /v1/completions` - Legacy completions

### Phase 3: Complete (Optional)
7. `GET /v1/api-key` - Key management
8. `GET /v1/embedding-models` - Embedding model listing
9. `POST /v1/complete` - Anthropic compatibility
10. `POST /v1/messages` - Anthropic compatibility

---

## API Compatibility Matrix

| API Standard | Endpoints | Notes |
|-------------|-----------|-------|
| OpenAI | 5 endpoints | `/chat/completions`, `/completions`, `/models`, `/models/{id}`, `/embeddings` |
| Anthropic | 2 endpoints | `/complete`, `/messages` |
| XAI-specific | 5 endpoints | `/api-key`, `/language-models*`, `/embedding-models*` |

---

## Authentication

**All endpoints require:**
```
Authorization: Bearer xai-YOUR_API_KEY
```

**Parameter format:**
```json
{
  "name": "Authorization",
  "in": "header",
  "required": true,
  "schema": { "type": "string" }
}
```

---

## Request/Response Formats

### Chat Completions
- **Request Schema:** `ChatRequest`
- **Response Schema:** `ChatResponse`
- **Supports:** Streaming (SSE), function calling, tool use

### Models
- **List Response:** `ListModelsResponse`
- **Single Response:** `Model`
- **Language Models:** `ListLanguageModelsResponse`, `LanguageModel`

### Embeddings
- **Request Schema:** `EmbeddingRequest`
- **Response Schema:** `EmbeddingResponse`
- **Models:** `ListEmbeddingModelsResponse`, `EmbeddingModel`

---

## Error Responses

**All endpoints return:**
- `200` - Success
- `400` - Bad request
- `404` - Not found (model-specific endpoints)

---

## Notes for Implementation

1. **OpenAI Compatibility Priority** - Focus on OpenAI-compatible endpoints first (5 endpoints)
2. **Streaming Support** - `/chat/completions` supports SSE streaming
3. **Legacy Endpoints** - `/completions` marked as legacy, prefer `/chat/completions`
4. **Anthropic Compatibility** - Optional, lower priority for Phase 1
5. **XAI-specific Features** - Enhanced model metadata via `/language-models` endpoints

---

**Total Endpoints:** 12
**OpenAI-compatible:** 5
**Anthropic-compatible:** 2
**XAI-specific:** 5