Skip to content

Commit 5f014e9

Browse files
authored
Update fleet.md (#4183)
1 parent dee2d1f commit 5f014e9

File tree

4 files changed

+46
-9
lines changed

4 files changed

+46
-9
lines changed

docs/dev/reference/apis/billing-client.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ async function connect(): Promise<VIAM.ViamClient> {
9797
return client;
9898
}
9999

100-
const appClient = await connect();
101-
const billingClient = appClient.billingClient;
100+
const viamClient = await connect();
101+
const billingClient = viamClient.billingClient;
102102
```
103103

104104
{{% /tab %}}

docs/dev/reference/apis/data-client.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ async function connect(): Promise<VIAM.ViamClient> {
112112
return client;
113113
}
114114

115-
const appClient = await connect();
116-
const dataClient = appClient.dataClient;
115+
const viamClient = await connect();
116+
const dataClient = viamClient.dataClient;
117117
```
118118

119119
{{% /tab %}}

docs/dev/reference/apis/fleet.md

+40-3
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,18 @@ The fleet management API supports the following methods:
4343

4444
## Establish a connection
4545

46-
To use the Viam fleet management API, you first need to instantiate a [`ViamClient`](https://python.viam.dev/autoapi/viam/app/viam_client/index.html#viam.app.viam_client.ViamClient) and then instantiate an [`AppClient`](https://python.viam.dev/autoapi/viam/app/app_client/index.html#viam.app.app_client.AppClient).
47-
See the following example for reference.
46+
To use the Viam fleet management API, you first need to instantiate a `ViamClient` and then instantiate an `AppClient`.
4847

49-
You can create an [API key](/manage/manage/access/) on your settings page.
48+
You will also need an API key and API key ID to authenticate your session.
49+
To get an API key (and corresponding ID), you have two options:
50+
51+
- [Create an API key using the Viam app](/operate/control/api-keys/#add-an-api-key)
52+
- [Create an API key using the Viam CLI](/dev/tools/cli/#create-an-organization-api-key)
53+
54+
The following example instantiates a `ViamClient`, authenticating with an API key, and then instantiates an `AppClient`:
55+
56+
{{< tabs >}}
57+
{{% tab name="Python" %}}
5058

5159
```python {class="line-numbers linkable-line-numbers"}
5260
import asyncio
@@ -83,6 +91,35 @@ if __name__ == '__main__':
8391
asyncio.run(main())
8492
```
8593

94+
{{% /tab %}}
95+
{{% tab name="TypeScript" %}}
96+
97+
```ts {class="line-numbers linkable-line-numbers" data-line="3,5"}
98+
async function connect(): Promise<VIAM.ViamClient> {
99+
// Replace "<API-KEY-ID>" (including brackets) with your machine's
100+
const API_KEY_ID = "<API-KEY-ID>";
101+
// Replace "<API-KEY>" (including brackets) with your machine's API key
102+
const API_KEY = "<API-KEY>";
103+
const opts: VIAM.ViamClientOptions = {
104+
serviceHost: "https://app.viam.com:443",
105+
credentials: {
106+
type: "api-key",
107+
authEntity: API_KEY_ID,
108+
payload: API_KEY,
109+
},
110+
};
111+
112+
const client = await VIAM.createViamClient(opts);
113+
return client;
114+
}
115+
116+
const viamClient = await connect();
117+
const appClient = appClient.appClient;
118+
```
119+
120+
{{% /tab %}}
121+
{{< /tabs >}}
122+
86123
Once you have instantiated an `AppClient`, you can run the following [API methods](#api) against the `AppClient` object (named `fleet` in the examples).
87124

88125
{{% hiddencontent %}}

docs/dev/reference/apis/ml-training-client.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ async function connect(): Promise<VIAM.ViamClient> {
9797
return client;
9898
}
9999

100-
const appClient = await connect();
101-
const mlTrainingClient = appClient.mlTrainingClient;
100+
const viamClient = await connect();
101+
const mlTrainingClient = viamClient.mlTrainingClient;
102102
```
103103

104104
{{% /tab %}}

0 commit comments

Comments
 (0)