Blame
|
1 | # SDKs |
||||||
| 2 | ||||||||
|
3 | AeThex does not currently publish a guaranteed stable first-party SDK release contract for the KAEL API. Use the OpenAPI contract or direct HTTP integration while interfaces are evolving. |
||||||
|
4 | |||||||
|
5 | | Field | Value | |
||||||
| 6 | |---|---| |
|||||||
| 7 | | Product maturity | In development | |
|||||||
| 8 | | Documentation status | Active | |
|||||||
| 9 | | Contract source | [[OpenAPI Reference]] | |
|||||||
| 10 | | Last source review | 2026-06-26 | |
|||||||
|
11 | |||||||
|
12 | ## Recommended approach |
||||||
| 13 | ||||||||
| 14 | For ordinary JSON endpoints: |
|||||||
| 15 | ||||||||
| 16 | 1. Download `/static/custom/openapi.yaml`. |
|||||||
| 17 | 2. Generate a client for your language. |
|||||||
| 18 | 3. Wrap generated code behind your own application boundary. |
|||||||
| 19 | 4. Pin the generated client to the contract version you reviewed. |
|||||||
| 20 | ||||||||
| 21 | For `/kael/stream`, use an SSE-capable fetch client. Many generated SDKs treat streaming responses as a plain string and need a small custom adapter. |
|||||||
|
22 | |||||||
| 23 | ## SDK responsibilities |
|||||||
| 24 | ||||||||
|
25 | An AeThex client library should provide: |
||||||
| 26 | ||||||||
| 27 | - Base URL configuration. |
|||||||
| 28 | - Typed request and response models. |
|||||||
| 29 | - Cookie or server-side tenant authentication. |
|||||||
| 30 | - SSE parsing. |
|||||||
| 31 | - Error normalization. |
|||||||
| 32 | - Timeouts and cancellation. |
|||||||
| 33 | - Safe retry behavior. |
|||||||
| 34 | - No logging of credentials. |
|||||||
| 35 | ||||||||
| 36 | ## Stability |
|||||||
| 37 | ||||||||
| 38 | - Client model keys are more stable than provider model IDs. |
|||||||
| 39 | - Public routes are more stable than privileged operator routes. |
|||||||
| 40 | - Experimental fields can change before a formal SDK release. |
|||||||
| 41 | - Review [[KAEL Changelog]] before regenerating. |
|||||||
| 42 | ||||||||
| 43 | ## Related documentation |
|||||||
| 44 | ||||||||
| 45 | - [[API Quickstart]] |
|||||||
| 46 | - [[API Reference]] |
|||||||
| 47 | - [[OpenAPI Reference]] |
|||||||
| 48 | - [[Rate Limits]] |
|||||||