api_xai 0.4.1

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

# docs

### Purpose

This directory contains technical documentation for the `api_xai` crate, organized into design collections following doc.rulebook.md standards. Documentation is structured by design dimension (invariant/, pattern/, operation/, etc.) with each collection containing a master file (`readme.md`) and NNN-prefixed instance files.

### Responsibility

| Path | Purpose |
|------|---------|
| `readme.md` | Master documentation index with navigation and Complete Entity Coverage |
| `invariant/` | Non-negotiable behavioral constraints — thin client principle, testing standards |
| `api/` | API contracts and endpoint coverage requirements |
| `feature/` | Optional feature behavior specifications — enterprise reliability modules |
| `operation/` | Operational procedures — secret loading, credential management |
| `pattern/` | Design pattern specifications — module organization (mod_interface) |
| `api_reference.md` | API reference documentation (endpoint descriptions, parameters, responses) |
| `openapi_endpoints_summary.md` | OpenAPI endpoint quick reference |
| `openapi.json` | Machine-readable OpenAPI 3.0 specification |
| `research_summary.md` | Research notes and API exploration findings |

### Collections

#### invariant/

Non-negotiable behavioral constraints.

**Master File**: `invariant/readme.md`

**Instances**:
- `001_thin_client_principle.md` — No automatic behaviors; all client actions must be explicit
- `002_testing_standards.md` — No-mock mandate and loud-failure requirement for all integration tests

#### api/

API contracts and endpoint coverage.

**Master File**: `api/readme.md`

**Instances**:
- `001_endpoint_coverage.md` — Required X.AI API endpoint coverage and feature-gating policy

#### feature/

Optional feature behavior specifications.

**Master File**: `feature/readme.md`

**Instances**:
- `001_enterprise_reliability.md` — Enterprise reliability feature set and configuration contract

#### operation/

Operational procedures for `api_xai`.

**Master File**: `operation/readme.md`

**Instances**:
- `001_secret_loading.md` — Load XAI_API_KEY via workspace secrets file or environment variable

#### pattern/

Design pattern specifications.

**Master File**: `pattern/readme.md`

**Instances**:
- `001_module_organization.md` — mod_interface pattern and module structure conventions

### Navigation

- Behavioral constraints: see `invariant/`
- API contracts and endpoint coverage: see `api/`
- Feature behavior specifications: see `feature/`
- Operational procedures (authentication, secret loading): see `operation/`
- Design patterns: see `pattern/`
- API reference (human-readable): see `api_reference.md`
- OpenAPI spec (tooling): see `openapi.json`
- Project overview: see `../readme.md`
- Usage examples: see `../examples/`