@healthcloudai/hc-sdk 3.0.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +23 -1
- package/dist/index.d.cts +19 -2
- package/dist/index.d.ts +19 -2
- package/dist/index.js +22 -1
- package/docs/clients/AmsClient.md +3 -0
- package/docs/clients/index.md +1 -0
- package/docs/docs-manifest.json +4 -2
- package/docs/examples/index.md +1 -0
- package/docs/index.md +1 -0
- package/docs/operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md +94 -0
- package/package.json +1 -1
package/docs/index.md
CHANGED
|
@@ -889,6 +889,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
889
889
|
- [Full-text search policy documents](operations/graph.searchPolicyDocuments.md) (`graph.searchPolicyDocuments`)
|
|
890
890
|
- [Search providers](operations/graph.searchProviders.md) (`graph.searchProviders`)
|
|
891
891
|
- [Search providers with a raw Cypher query](operations/graph.searchProvidersCypher.md) (`graph.searchProvidersCypher`)
|
|
892
|
+
- [List public and orchestrator agent IDs](operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md) (`list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get`)
|
|
892
893
|
- [GET /connect](operations/mcp.connect.md) (`mcp.connect`)
|
|
893
894
|
- [POST /fieldagent](operations/mcp.mcpFieldagent.md) (`mcp.mcpFieldagent`)
|
|
894
895
|
- [POST /patient](operations/mcp.mcpPatient.md) (`mcp.mcpPatient`)
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# List public and orchestrator agent IDs
|
|
2
|
+
|
|
3
|
+
Operation ID: `list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get`
|
|
4
|
+
|
|
5
|
+
Public, unauthenticated endpoint returning active Application-type agent IDs split into public and orchestrator lists.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listApplicationAgents`
|
|
10
|
+
|
|
11
|
+
Signature: `ams.listApplicationAgents(tenantId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<AmsApplicationAgentsResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **UNSPECIFIED**
|
|
18
|
+
|
|
19
|
+
## Prerequisites
|
|
20
|
+
|
|
21
|
+
None documented.
|
|
22
|
+
|
|
23
|
+
## HTTP
|
|
24
|
+
|
|
25
|
+
`GET /application/agents/{tenant_id}`
|
|
26
|
+
|
|
27
|
+
## Path parameters
|
|
28
|
+
|
|
29
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
30
|
+
|---|---|---:|---|---|---|---:|---|
|
|
31
|
+
| `tenant_id` | `string` | Yes | | | | No | |
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
None.
|
|
36
|
+
|
|
37
|
+
## Body parameters
|
|
38
|
+
|
|
39
|
+
None.
|
|
40
|
+
|
|
41
|
+
Request model: None.
|
|
42
|
+
|
|
43
|
+
## Request example
|
|
44
|
+
|
|
45
|
+
None declared in canonical OpenAPI.
|
|
46
|
+
|
|
47
|
+
## Success responses
|
|
48
|
+
|
|
49
|
+
| Status | Shape | Content type | Description |
|
|
50
|
+
|---|---|---|---|
|
|
51
|
+
| `200` | `object` | application/json | Successful response |
|
|
52
|
+
|
|
53
|
+
## Success response examples
|
|
54
|
+
|
|
55
|
+
None declared in canonical OpenAPI.
|
|
56
|
+
|
|
57
|
+
## Common errors
|
|
58
|
+
|
|
59
|
+
None declared in canonical OpenAPI.
|
|
60
|
+
|
|
61
|
+
## Error examples
|
|
62
|
+
|
|
63
|
+
None declared in canonical OpenAPI.
|
|
64
|
+
|
|
65
|
+
## NodeJS / TypeScript implementation
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
```ts
|
|
72
|
+
const tenantId = "<TENANT_ID>";
|
|
73
|
+
|
|
74
|
+
const result = await ams.listApplicationAgents(tenantId);
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## cURL
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
curl -X GET \
|
|
81
|
+
'https://dev-amsservices.health.cloud/api/ams/application/agents/%3CTENANT_ID%3E'
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Notes
|
|
85
|
+
|
|
86
|
+
None.
|
|
87
|
+
|
|
88
|
+
## Prepared Test Console scenario
|
|
89
|
+
|
|
90
|
+
No canonical scenario is currently associated.
|
|
91
|
+
|
|
92
|
+
## Real response
|
|
93
|
+
|
|
94
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
package/package.json
CHANGED