Skip to content

Commit b1fd403

Browse files
committed
Address non-typescript sdk
1 parent e275d4b commit b1fd403

1 file changed

Lines changed: 42 additions & 7 deletions

File tree

docs/sdk/overview.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,53 @@ title: Overview
77

88
[[GitHub](https://github.com/epilot-dev/sdk-js)] [[npm](https://www.npmjs.com/package/@epilot/sdk)]
99

10+
:::tip
11+
Every epilot API ships with a typed TypeScript client. Full types and IntelliSense out of the box.
12+
:::
13+
14+
:::info
15+
**Not using TypeScript?** All epilot APIs are published with standard [OpenAPI definitions](/api). You can generate a typed client in any language using tools like [openapi-generator](https://openapi-generator.tech/), [Speakeasy](https://speakeasyapi.dev/), or [Kiota](https://learn.microsoft.com/en-us/openapi/kiota/).
16+
:::
17+
18+
import Tabs from '@theme/Tabs';
19+
import TabItem from '@theme/TabItem';
20+
21+
## Install
22+
23+
<Tabs>
24+
<TabItem value="npm" label="npm" default>
25+
26+
```bash
27+
npm i @epilot/sdk axios openapi-client-axios
28+
```
29+
30+
</TabItem>
31+
<TabItem value="yarn" label="yarn">
32+
33+
```bash
34+
yarn add @epilot/sdk axios openapi-client-axios
35+
```
36+
37+
</TabItem>
38+
<TabItem value="pnpm" label="pnpm">
39+
40+
```bash
41+
pnpm add @epilot/sdk axios openapi-client-axios
42+
```
43+
44+
</TabItem>
45+
</Tabs>
46+
47+
1048
`@epilot/sdk` is the official TypeScript SDK for the epilot platform. One package, 30+ API clients, full type safety.
1149

50+
1251
- **Typed operations**: every endpoint has typed params and responses, generated from OpenAPI specs
1352
- **Tree-shakeable**: import only the APIs you use; unused clients never touch your bundle
1453
- **Lazy-loaded**: API specs are loaded on first use, not at import time
1554
- **Batteries included**: automatic retries, large response handling, and auth management out of the box
1655
- **Just an axios client**: every client is a standard [axios](https://axios-http.com/docs/intro) instance with typed methods from [openapi-client-axios](https://openapistack.co/docs/openapi-client-axios/intro/). Interceptors, defaults, and all other axios features work as expected.
1756

18-
## Install
19-
20-
```bash
21-
npm install @epilot/sdk axios openapi-client-axios
22-
```
2357

2458
## Quick start
2559

@@ -42,7 +76,8 @@ const { data: executions } = await epilot.workflow.getExecutions()
4276

4377
Each operation is forwarded to a lazy singleton. The spec is loaded and the client initialized on first use, then cached.
4478

45-
:::tip Only import what you need
79+
## Only import what you need
80+
4681
For smaller bundles, use tree-shakeable subpath imports:
4782

4883
```ts
@@ -53,7 +88,6 @@ const { data } = await entity.getEntity({ slug: 'contact', id: '123' })
5388
```
5489

5590
See [Client Usage](client-usage) for all import patterns.
56-
:::
5791

5892
## Available APIs
5993

@@ -102,3 +136,4 @@ See [Client Usage](client-usage) for all import patterns.
102136
| `epilot.workflow` | `@epilot/sdk/workflow` | [SDK](clients/workflow) · [API](/api/workflow-execution) |
103137
| `epilot.workflowDefinition` | `@epilot/sdk/workflow-definition` | [SDK](clients/workflow-definition) · [API](/api/workflow-definition) |
104138
<!-- /sdk-reference-table -->
139+

0 commit comments

Comments
 (0)