@orchestraworks/client 0.5.0 → 0.5.1

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.
Files changed (3) hide show
  1. package/README.md +25 -811
  2. package/docs/API.md +833 -0
  3. package/package.json +1 -1
package/docs/API.md ADDED
@@ -0,0 +1,833 @@
1
+ # @orchestraworks/client@0.5.1
2
+
3
+ A TypeScript client for the Orchestra public API.
4
+
5
+ ## Usage
6
+
7
+ First, install the SDK from npm.
8
+
9
+ ```bash
10
+ npm install @orchestraworks/client --save
11
+ ```
12
+
13
+ Configure a base URL, bearer token, and organization id before making organization-scoped calls.
14
+
15
+
16
+ ```ts
17
+ import {
18
+ Configuration,
19
+ AgentsApi,
20
+ } from '@orchestraworks/client';
21
+ import type { CreateAgentOperationRequest } from '@orchestraworks/client';
22
+
23
+ async function example() {
24
+ console.log("Calling the Orchestra platform API...");
25
+ const config = new Configuration({
26
+ // Configure HTTP bearer authorization: bearerAuth
27
+ accessToken: "YOUR BEARER TOKEN",
28
+ });
29
+ const api = new AgentsApi(config);
30
+
31
+ const body = {
32
+ // CreateAgentRequest
33
+ createAgentRequest: ...,
34
+ // string | Organization id or slug used to authorize this organization-scoped request; either one is accepted (optional)
35
+ xOrganizationId: xOrganizationId_example,
36
+ } satisfies CreateAgentOperationRequest;
37
+
38
+ try {
39
+ const data = await api.createAgent(body);
40
+ console.log(data);
41
+ } catch (error) {
42
+ console.error(error);
43
+ }
44
+ }
45
+
46
+ // Run the example
47
+ example().catch(console.error);
48
+ ```
49
+
50
+
51
+ ## Documentation
52
+
53
+ ### API Endpoints
54
+
55
+ All URIs are relative to the base URL, such as *https://api.orchestraworks.ai*
56
+
57
+ | Class | Method | HTTP request | Description
58
+ | ----- | ------ | ------------ | -------------
59
+ *AgentsApi* | [**createAgent**](AgentsApi.md#createagentoperation) | **POST** /agents |
60
+ *AgentsApi* | [**deleteAgent**](AgentsApi.md#deleteagent) | **DELETE** /agents/{id} |
61
+ *AgentsApi* | [**getAgent**](AgentsApi.md#getagent) | **GET** /agents/{id} |
62
+ *AgentsApi* | [**getAgentVersion**](AgentsApi.md#getagentversion) | **GET** /agents/{id}/versions/{versionIdOrNumber} |
63
+ *AgentsApi* | [**listAgentVersions**](AgentsApi.md#listagentversions) | **GET** /agents/{id}/versions |
64
+ *AgentsApi* | [**listAgents**](AgentsApi.md#listagents) | **GET** /agents |
65
+ *AgentsApi* | [**updateAgent**](AgentsApi.md#updateagentoperation) | **PATCH** /agents/{id} |
66
+ *ApiKeysApi* | [**createApiKey**](ApiKeysApi.md#createapikeyoperation) | **POST** /api-keys |
67
+ *ApiKeysApi* | [**getApiKey**](ApiKeysApi.md#getapikey) | **GET** /api-keys/{id} |
68
+ *ApiKeysApi* | [**listApiKeys**](ApiKeysApi.md#listapikeys) | **GET** /api-keys |
69
+ *ApiKeysApi* | [**revokeApiKey**](ApiKeysApi.md#revokeapikey) | **DELETE** /api-keys/{id} |
70
+ *ArtifactsApi* | [**createArtifact**](ArtifactsApi.md#createartifactoperation) | **POST** /artifacts |
71
+ *ArtifactsApi* | [**createArtifactVersion**](ArtifactsApi.md#createartifactversion) | **POST** /artifacts/{id}/versions |
72
+ *ArtifactsApi* | [**createComment**](ArtifactsApi.md#createcommentoperation) | **POST** /artifacts/{id}/comments |
73
+ *ArtifactsApi* | [**createReply**](ArtifactsApi.md#createreplyoperation) | **POST** /artifacts/{id}/comments/{commentId}/replies |
74
+ *ArtifactsApi* | [**deleteArtifact**](ArtifactsApi.md#deleteartifact) | **DELETE** /artifacts/{id} |
75
+ *ArtifactsApi* | [**deleteComment**](ArtifactsApi.md#deletecomment) | **DELETE** /artifacts/{id}/comments/{commentId} |
76
+ *ArtifactsApi* | [**deleteReply**](ArtifactsApi.md#deletereply) | **DELETE** /artifacts/{id}/comments/{commentId}/replies/{replyId} |
77
+ *ArtifactsApi* | [**getArtifact**](ArtifactsApi.md#getartifact) | **GET** /artifacts/{id} |
78
+ *ArtifactsApi* | [**getArtifactData**](ArtifactsApi.md#getartifactdata) | **GET** /artifacts/{id}/versions/{versionNumber}/data |
79
+ *ArtifactsApi* | [**getArtifactVersionContent**](ArtifactsApi.md#getartifactversioncontent) | **GET** /artifacts/{id}/versions/{versionNumber}/content |
80
+ *ArtifactsApi* | [**getArtifactVersionThumbnail**](ArtifactsApi.md#getartifactversionthumbnail) | **GET** /artifacts/{id}/versions/{versionNumber}/thumbnail |
81
+ *ArtifactsApi* | [**getComment**](ArtifactsApi.md#getcomment) | **GET** /artifacts/{id}/comments/{commentId} |
82
+ *ArtifactsApi* | [**listArtifacts**](ArtifactsApi.md#listartifacts) | **GET** /artifacts |
83
+ *ArtifactsApi* | [**listComments**](ArtifactsApi.md#listcomments) | **GET** /artifacts/{id}/comments |
84
+ *ArtifactsApi* | [**notifyArtifactAgent**](ArtifactsApi.md#notifyartifactagent) | **POST** /artifacts/{id}/agent-notices |
85
+ *ArtifactsApi* | [**reopenComment**](ArtifactsApi.md#reopencomment) | **POST** /artifacts/{id}/comments/{commentId}/reopen |
86
+ *ArtifactsApi* | [**resolveComment**](ArtifactsApi.md#resolvecomment) | **POST** /artifacts/{id}/comments/{commentId}/resolve |
87
+ *ArtifactsApi* | [**updateArtifact**](ArtifactsApi.md#updateartifactoperation) | **PATCH** /artifacts/{id} |
88
+ *ArtifactsApi* | [**updateComment**](ArtifactsApi.md#updatecommentoperation) | **PATCH** /artifacts/{id}/comments/{commentId} |
89
+ *ArtifactsApi* | [**updateReply**](ArtifactsApi.md#updatereplyoperation) | **PATCH** /artifacts/{id}/comments/{commentId}/replies/{replyId} |
90
+ *ArtifactsApi* | [**writeArtifactData**](ArtifactsApi.md#writeartifactdata) | **PATCH** /artifacts/{id}/versions/{versionNumber}/data |
91
+ *AuthApi* | [**authorizePublicClient**](AuthApi.md#authorizepublicclient) | **GET** /auth/authorize | Start a PKCE authorization for a public client
92
+ *AuthApi* | [**clearArtifactsHostCookies**](AuthApi.md#clearartifactshostcookies) | **GET** /auth/logout |
93
+ *AuthApi* | [**completeLogin**](AuthApi.md#completelogin) | **GET** /auth/callback |
94
+ *AuthApi* | [**createAuthHandoff**](AuthApi.md#createauthhandoffoperation) | **POST** /auth/handoffs |
95
+ *AuthApi* | [**exchangePublicClientToken**](AuthApi.md#exchangepublicclienttoken) | **POST** /auth/token | Exchange an authorization code or refresh token for platform credentials
96
+ *AuthApi* | [**redeemAuthHandoff**](AuthApi.md#redeemauthhandoff) | **GET** /auth/handoff |
97
+ *AuthApi* | [**redirectToLogin**](AuthApi.md#redirecttologin) | **GET** /auth/login |
98
+ *AuthApi* | [**refreshSession**](AuthApi.md#refreshsession) | **POST** /auth/refresh | Exchange the browser refresh cookie for a fresh access token
99
+ *AuthApi* | [**startLogin**](AuthApi.md#startlogin) | **POST** /auth/login |
100
+ *AuthApi* | [**startLogout**](AuthApi.md#startlogout) | **POST** /auth/logout |
101
+ *ComputeEnrollmentsApi* | [**createMachineEnrollment**](ComputeEnrollmentsApi.md#createmachineenrollmentoperation) | **POST** /compute-enrollments |
102
+ *ComputeEnrollmentsApi* | [**getMachineEnrollment**](ComputeEnrollmentsApi.md#getmachineenrollment) | **GET** /compute-enrollments/{id} |
103
+ *ComputeEnrollmentsApi* | [**listMachineEnrollments**](ComputeEnrollmentsApi.md#listmachineenrollments) | **GET** /compute-enrollments |
104
+ *ComputeEnrollmentsApi* | [**revokeMachineEnrollment**](ComputeEnrollmentsApi.md#revokemachineenrollment) | **POST** /compute-enrollments/{id}/revoke |
105
+ *ComputeProvidersApi* | [**createComputeProvider**](ComputeProvidersApi.md#createcomputeprovideroperation) | **POST** /compute-providers |
106
+ *ComputeProvidersApi* | [**deleteComputeProvider**](ComputeProvidersApi.md#deletecomputeprovider) | **DELETE** /compute-providers/{id} |
107
+ *ComputeProvidersApi* | [**getComputeProvider**](ComputeProvidersApi.md#getcomputeprovider) | **GET** /compute-providers/{id} |
108
+ *ComputeProvidersApi* | [**listComputeProviders**](ComputeProvidersApi.md#listcomputeproviders) | **GET** /compute-providers |
109
+ *ComputeProvidersApi* | [**pollComputeProvider**](ComputeProvidersApi.md#pollcomputeprovideroperation) | **POST** /compute-providers/{id}/poll |
110
+ *ComputeProvidersApi* | [**reportComputeProvider**](ComputeProvidersApi.md#reportcomputeprovideroperation) | **POST** /compute-providers/{id}/report |
111
+ *ComputeProvidersApi* | [**updateComputeProvider**](ComputeProvidersApi.md#updatecomputeprovideroperation) | **PATCH** /compute-providers/{id} |
112
+ *ConnectionInstallLinksApi* | [**createConnectionInstallLink**](ConnectionInstallLinksApi.md#createconnectioninstalllinkoperation) | **POST** /install-links |
113
+ *ConnectionInstallLinksApi* | [**landConnectionInstallLink**](ConnectionInstallLinksApi.md#landconnectioninstalllink) | **GET** /integrations/install/{linkToken} |
114
+ *ConnectionInstallLinksApi* | [**listConnectionInstallLinks**](ConnectionInstallLinksApi.md#listconnectioninstalllinks) | **GET** /install-links |
115
+ *ConnectionsApi* | [**authorizeConnection**](ConnectionsApi.md#authorizeconnection) | **POST** /connections/{id}/authorize |
116
+ *ConnectionsApi* | [**createConnection**](ConnectionsApi.md#createconnectionoperation) | **POST** /connections |
117
+ *ConnectionsApi* | [**deleteConnection**](ConnectionsApi.md#deleteconnection) | **DELETE** /connections/{id} |
118
+ *ConnectionsApi* | [**getConnection**](ConnectionsApi.md#getconnection) | **GET** /connections/{id} |
119
+ *ConnectionsApi* | [**listConnectionEventTypes**](ConnectionsApi.md#listconnectioneventtypes) | **GET** /connections/{id}/events |
120
+ *ConnectionsApi* | [**listConnections**](ConnectionsApi.md#listconnections) | **GET** /connections |
121
+ *ConnectionsApi* | [**recordConnectionEvent**](ConnectionsApi.md#recordconnectioneventoperation) | **POST** /connections/{id}/events |
122
+ *ConnectionsApi* | [**rotateConnectionWebhookToken**](ConnectionsApi.md#rotateconnectionwebhooktoken) | **POST** /connections/{id}/rotate-webhook-token |
123
+ *ConnectionsApi* | [**updateConnection**](ConnectionsApi.md#updateconnectionoperation) | **PATCH** /connections/{id} |
124
+ *ConnectorsApi* | [**confirmWebhookToken**](ConnectorsApi.md#confirmwebhooktoken) | **POST** /connectors/{id}/confirm-webhook-token |
125
+ *ConnectorsApi* | [**createConnector**](ConnectorsApi.md#createconnectoroperation) | **POST** /connectors |
126
+ *ConnectorsApi* | [**deleteConnector**](ConnectorsApi.md#deleteconnector) | **DELETE** /connectors/{id} |
127
+ *ConnectorsApi* | [**discardWebhookToken**](ConnectorsApi.md#discardwebhooktoken) | **POST** /connectors/{id}/discard-webhook-token |
128
+ *ConnectorsApi* | [**getConnector**](ConnectorsApi.md#getconnector) | **GET** /connectors/{id} |
129
+ *ConnectorsApi* | [**listConnectors**](ConnectorsApi.md#listconnectors) | **GET** /connectors |
130
+ *ConnectorsApi* | [**rotateConnectorWebhookToken**](ConnectorsApi.md#rotateconnectorwebhooktoken) | **POST** /connectors/{id}/rotate-webhook-token |
131
+ *ConnectorsApi* | [**updateConnector**](ConnectorsApi.md#updateconnectoroperation) | **PATCH** /connectors/{id} |
132
+ *DashboardsApi* | [**createDashboard**](DashboardsApi.md#createdashboardoperation) | **POST** /dashboards |
133
+ *DashboardsApi* | [**deleteDashboard**](DashboardsApi.md#deletedashboard) | **DELETE** /dashboards/{id} |
134
+ *DashboardsApi* | [**getDashboard**](DashboardsApi.md#getdashboard) | **GET** /dashboards/{id} |
135
+ *DashboardsApi* | [**listDashboards**](DashboardsApi.md#listdashboards) | **GET** /dashboards |
136
+ *DashboardsApi* | [**updateDashboard**](DashboardsApi.md#updatedashboardoperation) | **PATCH** /dashboards/{id} |
137
+ *DecisionsApi* | [**createDecision**](DecisionsApi.md#createdecisionoperation) | **POST** /decisions |
138
+ *DeliveriesApi* | [**getDelivery**](DeliveriesApi.md#getdelivery) | **GET** /deliveries/{id} |
139
+ *DeliveriesApi* | [**listDeliveries**](DeliveriesApi.md#listdeliveries) | **GET** /deliveries |
140
+ *DeliveriesApi* | [**replayDelivery**](DeliveriesApi.md#replaydelivery) | **POST** /deliveries/{id}/replay |
141
+ *EnvironmentsApi* | [**createEnvironment**](EnvironmentsApi.md#createenvironmentoperation) | **POST** /environments |
142
+ *EnvironmentsApi* | [**deleteEnvironment**](EnvironmentsApi.md#deleteenvironment) | **DELETE** /environments/{id} |
143
+ *EnvironmentsApi* | [**getEnvironment**](EnvironmentsApi.md#getenvironment) | **GET** /environments/{id} |
144
+ *EnvironmentsApi* | [**listEnvironments**](EnvironmentsApi.md#listenvironments) | **GET** /environments |
145
+ *EnvironmentsApi* | [**updateEnvironment**](EnvironmentsApi.md#updateenvironmentoperation) | **PATCH** /environments/{id} |
146
+ *EventsApi* | [**listEvents**](EventsApi.md#listevents) | **GET** /events | List bus events (the durable event bus timeline)
147
+ *FilesApi* | [**completeFileUpload**](FilesApi.md#completefileuploadoperation) | **POST** /files/{id}/complete |
148
+ *FilesApi* | [**createFile**](FilesApi.md#createfileoperation) | **POST** /files |
149
+ *FilesApi* | [**deleteFile**](FilesApi.md#deletefile) | **DELETE** /files/{id} |
150
+ *FilesApi* | [**getFile**](FilesApi.md#getfile) | **GET** /files/{id} |
151
+ *FilesApi* | [**getFileContent**](FilesApi.md#getfilecontent) | **GET** /files/{id}/content |
152
+ *FilesApi* | [**listFiles**](FilesApi.md#listfiles) | **GET** /files |
153
+ *GatewayKeysApi* | [**createGatewayKey**](GatewayKeysApi.md#creategatewaykeyoperation) | **POST** /gateway-keys |
154
+ *GatewayKeysApi* | [**deleteGatewayKey**](GatewayKeysApi.md#deletegatewaykey) | **DELETE** /gateway-keys/{id} |
155
+ *GatewayKeysApi* | [**getGatewayKey**](GatewayKeysApi.md#getgatewaykey) | **GET** /gateway-keys/{id} |
156
+ *GatewayKeysApi* | [**listGatewayKeys**](GatewayKeysApi.md#listgatewaykeys) | **GET** /gateway-keys |
157
+ *GatewayKeysApi* | [**updateGatewayKey**](GatewayKeysApi.md#updategatewaykeyoperation) | **PATCH** /gateway-keys/{id} |
158
+ *GitHubProviderSetupApi* | [**completeGitHubProviderConnectionIntent**](GitHubProviderSetupApi.md#completegithubproviderconnectionintent) | **GET** /integrations/github/callback |
159
+ *GroupsApi* | [**createGroup**](GroupsApi.md#creategroupoperation) | **POST** /groups |
160
+ *GroupsApi* | [**deleteGroup**](GroupsApi.md#deletegroup) | **DELETE** /groups/{id} |
161
+ *GroupsApi* | [**getGroup**](GroupsApi.md#getgroup) | **GET** /groups/{id} |
162
+ *GroupsApi* | [**listGroups**](GroupsApi.md#listgroups) | **GET** /groups |
163
+ *GroupsApi* | [**updateGroup**](GroupsApi.md#updategroupoperation) | **PATCH** /groups/{id} |
164
+ *HealthApi* | [**health**](HealthApi.md#health) | **GET** /health |
165
+ *MachinesApi* | [**createAccessToken**](MachinesApi.md#createaccesstoken) | **POST** /machines/{id}/access-tokens |
166
+ *MachinesApi* | [**createMachine**](MachinesApi.md#createmachineoperation) | **POST** /machines |
167
+ *MachinesApi* | [**createMachineEndpoint**](MachinesApi.md#createmachineendpointoperation) | **POST** /machines/{id}/endpoints |
168
+ *MachinesApi* | [**createView**](MachinesApi.md#createview) | **POST** /machines/{id}/views |
169
+ *MachinesApi* | [**createViewAccessToken**](MachinesApi.md#createviewaccesstoken) | **POST** /machines/{id}/views/{viewId}/access-tokens |
170
+ *MachinesApi* | [**deleteMachine**](MachinesApi.md#deletemachine) | **DELETE** /machines/{id} |
171
+ *MachinesApi* | [**deleteMachineEndpoint**](MachinesApi.md#deletemachineendpoint) | **DELETE** /machines/{id}/endpoints/{port} |
172
+ *MachinesApi* | [**deleteView**](MachinesApi.md#deleteview) | **DELETE** /machines/{id}/views/{viewId} |
173
+ *MachinesApi* | [**getDiagnostics**](MachinesApi.md#getdiagnostics) | **GET** /machines/{id}/diagnostics |
174
+ *MachinesApi* | [**getMachine**](MachinesApi.md#getmachine) | **GET** /machines/{id} |
175
+ *MachinesApi* | [**getView**](MachinesApi.md#getview) | **GET** /machines/{id}/views/{viewId} |
176
+ *MachinesApi* | [**listAccessTokens**](MachinesApi.md#listaccesstokens) | **GET** /machines/{id}/access-tokens |
177
+ *MachinesApi* | [**listMachines**](MachinesApi.md#listmachines) | **GET** /machines |
178
+ *MachinesApi* | [**listViews**](MachinesApi.md#listviews) | **GET** /machines/{id}/views |
179
+ *MachinesApi* | [**releaseViewControl**](MachinesApi.md#releaseviewcontrol) | **DELETE** /machines/{id}/views/{viewId}/control |
180
+ *MachinesApi* | [**resumeMachine**](MachinesApi.md#resumemachine) | **POST** /machines/{id}/resume |
181
+ *MachinesApi* | [**revokeAccessToken**](MachinesApi.md#revokeaccesstoken) | **DELETE** /machines/{id}/access-tokens/{tokenId} |
182
+ *MachinesApi* | [**stopMachine**](MachinesApi.md#stopmachine) | **POST** /machines/{id}/stop |
183
+ *MachinesApi* | [**suspendMachine**](MachinesApi.md#suspendmachineoperation) | **POST** /machines/{id}/suspend |
184
+ *MachinesApi* | [**takeViewControl**](MachinesApi.md#takeviewcontrol) | **POST** /machines/{id}/views/{viewId}/control |
185
+ *MetricsApi* | [**createMetric**](MetricsApi.md#createmetricoperation) | **POST** /metrics |
186
+ *MetricsApi* | [**deleteMetric**](MetricsApi.md#deletemetric) | **DELETE** /metrics/{id} |
187
+ *MetricsApi* | [**deleteMetricValue**](MetricsApi.md#deletemetricvalue) | **DELETE** /metrics/{id}/values/{valueId} |
188
+ *MetricsApi* | [**getMetric**](MetricsApi.md#getmetric) | **GET** /metrics/{id} |
189
+ *MetricsApi* | [**listMetricValues**](MetricsApi.md#listmetricvalues) | **GET** /metrics/{id}/values |
190
+ *MetricsApi* | [**listMetrics**](MetricsApi.md#listmetrics) | **GET** /metrics |
191
+ *MetricsApi* | [**readMetricRollup**](MetricsApi.md#readmetricrollup) | **GET** /metrics/{id}/rollup |
192
+ *MetricsApi* | [**updateMetric**](MetricsApi.md#updatemetricoperation) | **PATCH** /metrics/{id} |
193
+ *MetricsApi* | [**writeMetricValue**](MetricsApi.md#writemetricvalueoperation) | **POST** /metrics/{id}/values |
194
+ *ModelAliasesApi* | [**createModelAlias**](ModelAliasesApi.md#createmodelaliasoperation) | **POST** /model-aliases |
195
+ *ModelAliasesApi* | [**deleteModelAlias**](ModelAliasesApi.md#deletemodelalias) | **DELETE** /model-aliases/{id} |
196
+ *ModelAliasesApi* | [**getModelAlias**](ModelAliasesApi.md#getmodelalias) | **GET** /model-aliases/{id} |
197
+ *ModelAliasesApi* | [**listModelAliases**](ModelAliasesApi.md#listmodelaliases) | **GET** /model-aliases |
198
+ *ModelAliasesApi* | [**updateModelAlias**](ModelAliasesApi.md#updatemodelaliasoperation) | **PATCH** /model-aliases/{id} |
199
+ *ModelConfigsApi* | [**createModelConfig**](ModelConfigsApi.md#createmodelconfigoperation) | **POST** /model-configs |
200
+ *ModelConfigsApi* | [**deleteModelConfig**](ModelConfigsApi.md#deletemodelconfig) | **DELETE** /model-configs/{id} |
201
+ *ModelConfigsApi* | [**getModelConfig**](ModelConfigsApi.md#getmodelconfig) | **GET** /model-configs/{id} |
202
+ *ModelConfigsApi* | [**listModelConfigs**](ModelConfigsApi.md#listmodelconfigs) | **GET** /model-configs |
203
+ *ModelConfigsApi* | [**updateModelConfig**](ModelConfigsApi.md#updatemodelconfigoperation) | **PATCH** /model-configs/{id} |
204
+ *ModelProviderKeysApi* | [**createModelProviderKey**](ModelProviderKeysApi.md#createmodelproviderkeyoperation) | **POST** /model-provider-keys |
205
+ *ModelProviderKeysApi* | [**deleteModelProviderKey**](ModelProviderKeysApi.md#deletemodelproviderkey) | **DELETE** /model-provider-keys/{id} |
206
+ *ModelProviderKeysApi* | [**getModelProviderKey**](ModelProviderKeysApi.md#getmodelproviderkey) | **GET** /model-provider-keys/{id} |
207
+ *ModelProviderKeysApi* | [**listModelProviderKeys**](ModelProviderKeysApi.md#listmodelproviderkeys) | **GET** /model-provider-keys |
208
+ *ModelProviderKeysApi* | [**updateModelProviderKey**](ModelProviderKeysApi.md#updatemodelproviderkeyoperation) | **PATCH** /model-provider-keys/{id} |
209
+ *ModelProvidersApi* | [**getModelProvider**](ModelProvidersApi.md#getmodelprovider) | **GET** /model-providers/{id} |
210
+ *ModelProvidersApi* | [**listModelProviders**](ModelProvidersApi.md#listmodelproviders) | **GET** /model-providers |
211
+ *ModelsApi* | [**getModel**](ModelsApi.md#getmodel) | **GET** /models/{id} |
212
+ *ModelsApi* | [**listModels**](ModelsApi.md#listmodels) | **GET** /models |
213
+ *OrganizationInvitationsApi* | [**acceptInvitation**](OrganizationInvitationsApi.md#acceptinvitation) | **POST** /organization-invitations/{id}/accept |
214
+ *OrganizationInvitationsApi* | [**createInvitation**](OrganizationInvitationsApi.md#createinvitation) | **POST** /organization-invitations |
215
+ *OrganizationInvitationsApi* | [**deleteInvitation**](OrganizationInvitationsApi.md#deleteinvitation) | **DELETE** /organization-invitations/{id} |
216
+ *OrganizationInvitationsApi* | [**getInvitation**](OrganizationInvitationsApi.md#getinvitation) | **GET** /organization-invitations/{id} |
217
+ *OrganizationInvitationsApi* | [**listInvitations**](OrganizationInvitationsApi.md#listinvitations) | **GET** /organization-invitations |
218
+ *OrganizationInvitationsApi* | [**updateInvitation**](OrganizationInvitationsApi.md#updateinvitation) | **PATCH** /organization-invitations/{id} |
219
+ *OrganizationMembershipsApi* | [**createMembership**](OrganizationMembershipsApi.md#createmembership) | **POST** /organization-memberships |
220
+ *OrganizationMembershipsApi* | [**deleteMembership**](OrganizationMembershipsApi.md#deletemembership) | **DELETE** /organization-memberships/{id} |
221
+ *OrganizationMembershipsApi* | [**getMembership**](OrganizationMembershipsApi.md#getmembership) | **GET** /organization-memberships/{id} |
222
+ *OrganizationMembershipsApi* | [**listMemberships**](OrganizationMembershipsApi.md#listmemberships) | **GET** /organization-memberships |
223
+ *OrganizationMembershipsApi* | [**updateMembership**](OrganizationMembershipsApi.md#updatemembership) | **PATCH** /organization-memberships/{id} |
224
+ *OrganizationsApi* | [**bindWorkOsOrganization**](OrganizationsApi.md#bindworkosorganization) | **POST** /organizations/{id}/workos-binding |
225
+ *OrganizationsApi* | [**createOrganization**](OrganizationsApi.md#createorganizationoperation) | **POST** /organizations |
226
+ *OrganizationsApi* | [**generateAdminPortalLink**](OrganizationsApi.md#generateadminportallink) | **POST** /organizations/{id}/admin-portal-link |
227
+ *OrganizationsApi* | [**getCreditLedger**](OrganizationsApi.md#getcreditledger) | **GET** /organizations/{id}/credit-ledger |
228
+ *OrganizationsApi* | [**getEntitlements**](OrganizationsApi.md#getentitlements) | **GET** /organizations/{id}/entitlements |
229
+ *OrganizationsApi* | [**getOrganization**](OrganizationsApi.md#getorganization) | **GET** /organizations/{id} |
230
+ *OrganizationsApi* | [**listOrganizations**](OrganizationsApi.md#listorganizations) | **GET** /organizations |
231
+ *OrganizationsApi* | [**updateOrganization**](OrganizationsApi.md#updateorganizationoperation) | **PATCH** /organizations/{id} |
232
+ *PipelinesApi* | [**createPipeline**](PipelinesApi.md#createpipelineoperation) | **POST** /pipelines |
233
+ *PipelinesApi* | [**createPipelineWorkflow**](PipelinesApi.md#createpipelineworkflowoperation) | **POST** /pipelines/{id}/workflows |
234
+ *PipelinesApi* | [**deletePipeline**](PipelinesApi.md#deletepipeline) | **DELETE** /pipelines/{id} |
235
+ *PipelinesApi* | [**deletePipelineWorkflow**](PipelinesApi.md#deletepipelineworkflow) | **DELETE** /pipelines/{id}/workflows/{entryId} |
236
+ *PipelinesApi* | [**getPipeline**](PipelinesApi.md#getpipeline) | **GET** /pipelines/{id} |
237
+ *PipelinesApi* | [**listPipelines**](PipelinesApi.md#listpipelines) | **GET** /pipelines |
238
+ *PipelinesApi* | [**previewPipeline**](PipelinesApi.md#previewpipelineoperation) | **POST** /pipelines/{id}/preview |
239
+ *PipelinesApi* | [**updatePipeline**](PipelinesApi.md#updatepipelineoperation) | **PATCH** /pipelines/{id} |
240
+ *PipelinesApi* | [**updatePipelineWorkflow**](PipelinesApi.md#updatepipelineworkflowoperation) | **PATCH** /pipelines/{id}/workflows/{entryId} |
241
+ *PoliciesApi* | [**createPolicy**](PoliciesApi.md#createpolicyoperation) | **POST** /policies |
242
+ *PoliciesApi* | [**deletePolicy**](PoliciesApi.md#deletepolicy) | **DELETE** /policies/{id} |
243
+ *PoliciesApi* | [**getPolicy**](PoliciesApi.md#getpolicy) | **GET** /policies/{id} |
244
+ *PoliciesApi* | [**listPolicies**](PoliciesApi.md#listpolicies) | **GET** /policies |
245
+ *PoliciesApi* | [**updatePolicy**](PoliciesApi.md#updatepolicyoperation) | **PATCH** /policies/{id} |
246
+ *PreferencesApi* | [**getPreferences**](PreferencesApi.md#getpreferences) | **GET** /me/preferences |
247
+ *PreferencesApi* | [**updatePreferences**](PreferencesApi.md#updatepreferencesoperation) | **PATCH** /me/preferences |
248
+ *ProjectsApi* | [**createProject**](ProjectsApi.md#createprojectoperation) | **POST** /projects |
249
+ *ProjectsApi* | [**deleteProject**](ProjectsApi.md#deleteproject) | **DELETE** /projects/{id} |
250
+ *ProjectsApi* | [**getProject**](ProjectsApi.md#getproject) | **GET** /projects/{id} |
251
+ *ProjectsApi* | [**listProjects**](ProjectsApi.md#listprojects) | **GET** /projects |
252
+ *ProjectsApi* | [**updateProject**](ProjectsApi.md#updateprojectoperation) | **PATCH** /projects/{id} |
253
+ *ProviderConnectionIntentsApi* | [**createConnectionIntent**](ProviderConnectionIntentsApi.md#createconnectionintent) | **POST** /connection-intents |
254
+ *ProviderConnectionIntentsApi* | [**getConnectionIntent**](ProviderConnectionIntentsApi.md#getconnectionintent) | **GET** /connection-intents/{id} |
255
+ *ProviderConnectionIntentsApi* | [**listConnectionIntents**](ProviderConnectionIntentsApi.md#listconnectionintents) | **GET** /connection-intents |
256
+ *ProviderSetupApi* | [**completeProviderConnectionIntent**](ProviderSetupApi.md#completeproviderconnectionintent) | **GET** /integrations/{provider}/callback |
257
+ *ProvidersApi* | [**getProvider**](ProvidersApi.md#getprovider) | **GET** /providers/{id} |
258
+ *ProvidersApi* | [**listProviders**](ProvidersApi.md#listproviders) | **GET** /providers |
259
+ *RolesApi* | [**createRole**](RolesApi.md#createroleoperation) | **POST** /roles |
260
+ *RolesApi* | [**deleteRole**](RolesApi.md#deleterole) | **DELETE** /roles/{id} |
261
+ *RolesApi* | [**getRole**](RolesApi.md#getrole) | **GET** /roles/{id} |
262
+ *RolesApi* | [**listRoles**](RolesApi.md#listroles) | **GET** /roles |
263
+ *RolesApi* | [**updateRole**](RolesApi.md#updateroleoperation) | **PATCH** /roles/{id} |
264
+ *RoomTokensApi* | [**createRoomToken**](RoomTokensApi.md#createroomtokenoperation) | **POST** /room-tokens |
265
+ *SecretsApi* | [**createSecret**](SecretsApi.md#createsecretoperation) | **POST** /secrets |
266
+ *SecretsApi* | [**deleteSecret**](SecretsApi.md#deletesecret) | **DELETE** /secrets/{id} |
267
+ *SecretsApi* | [**getSecret**](SecretsApi.md#getsecret) | **GET** /secrets/{id} |
268
+ *SecretsApi* | [**listSecrets**](SecretsApi.md#listsecrets) | **GET** /secrets |
269
+ *SecretsApi* | [**updateSecret**](SecretsApi.md#updatesecretoperation) | **PATCH** /secrets/{id} |
270
+ *ServiceAccountsApi* | [**createServiceAccount**](ServiceAccountsApi.md#createserviceaccountoperation) | **POST** /service-accounts |
271
+ *ServiceAccountsApi* | [**deleteServiceAccount**](ServiceAccountsApi.md#deleteserviceaccount) | **DELETE** /service-accounts/{id} |
272
+ *ServiceAccountsApi* | [**getServiceAccount**](ServiceAccountsApi.md#getserviceaccount) | **GET** /service-accounts/{id} |
273
+ *ServiceAccountsApi* | [**listServiceAccounts**](ServiceAccountsApi.md#listserviceaccounts) | **GET** /service-accounts |
274
+ *ServiceAccountsApi* | [**updateServiceAccount**](ServiceAccountsApi.md#updateserviceaccountoperation) | **PATCH** /service-accounts/{id} |
275
+ *SessionsApi* | [**appendSessionItem**](SessionsApi.md#appendsessionitemoperation) | **POST** /sessions/{id}/items |
276
+ *SessionsApi* | [**deleteSessionItem**](SessionsApi.md#deletesessionitem) | **DELETE** /sessions/{id}/items/{itemId} |
277
+ *SessionsApi* | [**getSession**](SessionsApi.md#getsession) | **GET** /sessions/{id} |
278
+ *SessionsApi* | [**getSessionItem**](SessionsApi.md#getsessionitem) | **GET** /sessions/{id}/items/{itemId} |
279
+ *SessionsApi* | [**interruptSession**](SessionsApi.md#interruptsessionoperation) | **POST** /sessions/{id}/interrupt |
280
+ *SessionsApi* | [**listSessionItems**](SessionsApi.md#listsessionitems) | **GET** /sessions/{id}/items |
281
+ *SessionsApi* | [**listSessions**](SessionsApi.md#listsessions) | **GET** /sessions |
282
+ *SessionsApi* | [**startSession**](SessionsApi.md#startsession) | **POST** /sessions |
283
+ *SessionsApi* | [**updateSession**](SessionsApi.md#updatesessionoperation) | **PATCH** /sessions/{id} |
284
+ *SkillsApi* | [**createSkill**](SkillsApi.md#createskilloperation) | **POST** /skills |
285
+ *SkillsApi* | [**deleteSkill**](SkillsApi.md#deleteskill) | **DELETE** /skills/{id} |
286
+ *SkillsApi* | [**getSkill**](SkillsApi.md#getskill) | **GET** /skills/{id} |
287
+ *SkillsApi* | [**listSkills**](SkillsApi.md#listskills) | **GET** /skills |
288
+ *SkillsApi* | [**updateSkill**](SkillsApi.md#updateskilloperation) | **PATCH** /skills/{id} |
289
+ *SlackProviderConnectionCallbackControllerApi* | [**completeSlackProviderConnectionIntent**](SlackProviderConnectionCallbackControllerApi.md#completeslackproviderconnectionintent) | **GET** /integrations/slack/callback |
290
+ *TeamsProviderConnectionCallbackControllerApi* | [**completeTeamsProviderConnectionIntent**](TeamsProviderConnectionCallbackControllerApi.md#completeteamsproviderconnectionintent) | **GET** /integrations/teams/callback |
291
+ *TriggersApi* | [**createTrigger**](TriggersApi.md#createtriggeroperation) | **POST** /triggers |
292
+ *TriggersApi* | [**deleteTrigger**](TriggersApi.md#deletetrigger) | **DELETE** /triggers/{id} |
293
+ *TriggersApi* | [**getTrigger**](TriggersApi.md#gettrigger) | **GET** /triggers/{id} |
294
+ *TriggersApi* | [**listTriggers**](TriggersApi.md#listtriggers) | **GET** /triggers |
295
+ *TriggersApi* | [**updateTrigger**](TriggersApi.md#updatetriggeroperation) | **PATCH** /triggers/{id} |
296
+ *UserGrantsApi* | [**createUserGrant**](UserGrantsApi.md#createusergrantoperation) | **POST** /user-grants |
297
+ *UserGrantsApi* | [**getUserGrant**](UserGrantsApi.md#getusergrant) | **GET** /user-grants/{id} |
298
+ *UserGrantsApi* | [**listUserGrants**](UserGrantsApi.md#listusergrants) | **GET** /user-grants |
299
+ *UserGrantsApi* | [**revokeUserGrant**](UserGrantsApi.md#revokeusergrant) | **DELETE** /user-grants/{id} |
300
+ *UsersApi* | [**createUser**](UsersApi.md#createuseroperation) | **POST** /users |
301
+ *UsersApi* | [**getCurrentUser**](UsersApi.md#getcurrentuser) | **GET** /me |
302
+ *UsersApi* | [**getUser**](UsersApi.md#getuser) | **GET** /users/{id} |
303
+ *UsersApi* | [**listUsers**](UsersApi.md#listusers) | **GET** /users |
304
+ *UsersApi* | [**updateUser**](UsersApi.md#updateuseroperation) | **PATCH** /users/{id} |
305
+ *VolumesApi* | [**createVolume**](VolumesApi.md#createvolumeoperation) | **POST** /volumes |
306
+ *VolumesApi* | [**deleteVolume**](VolumesApi.md#deletevolume) | **DELETE** /volumes/{id} |
307
+ *VolumesApi* | [**getVolume**](VolumesApi.md#getvolume) | **GET** /volumes/{id} |
308
+ *VolumesApi* | [**listVolumes**](VolumesApi.md#listvolumes) | **GET** /volumes |
309
+ *VolumesApi* | [**updateVolume**](VolumesApi.md#updatevolumeoperation) | **PATCH** /volumes/{id} |
310
+ *WebhookIngressApi* | [**receiveWebhook**](WebhookIngressApi.md#receivewebhook) | **POST** /integrations/webhooks/{token} |
311
+ *WorkItemsApi* | [**assignWorkItem**](WorkItemsApi.md#assignworkitemoperation) | **POST** /work-items/{id}/assign |
312
+ *WorkItemsApi* | [**createWorkItem**](WorkItemsApi.md#createworkitemoperation) | **POST** /work-items |
313
+ *WorkItemsApi* | [**createWorkItemActivity**](WorkItemsApi.md#createworkitemactivityoperation) | **POST** /work-items/{id}/activities |
314
+ *WorkItemsApi* | [**deleteWorkItem**](WorkItemsApi.md#deleteworkitem) | **DELETE** /work-items/{id} |
315
+ *WorkItemsApi* | [**getWorkItem**](WorkItemsApi.md#getworkitem) | **GET** /work-items/{id} |
316
+ *WorkItemsApi* | [**linkWorkItem**](WorkItemsApi.md#linkworkitemoperation) | **POST** /work-items/{id}/links |
317
+ *WorkItemsApi* | [**listWorkItemActivities**](WorkItemsApi.md#listworkitemactivities) | **GET** /work-items/{id}/activities |
318
+ *WorkItemsApi* | [**listWorkItems**](WorkItemsApi.md#listworkitems) | **GET** /work-items |
319
+ *WorkItemsApi* | [**messageWorkItem**](WorkItemsApi.md#messageworkitemoperation) | **POST** /work-items/{id}/message |
320
+ *WorkItemsApi* | [**moveWorkItem**](WorkItemsApi.md#moveworkitemoperation) | **POST** /work-items/{id}/move |
321
+ *WorkItemsApi* | [**resetMoveCount**](WorkItemsApi.md#resetmovecount) | **POST** /work-items/{id}/reset-move-count |
322
+ *WorkItemsApi* | [**setWorkItemCheck**](WorkItemsApi.md#setworkitemcheckoperation) | **PUT** /work-items/{id}/checks/{key} |
323
+ *WorkItemsApi* | [**unlinkWorkItem**](WorkItemsApi.md#unlinkworkitem) | **DELETE** /work-items/{id}/links/{kind}/{otherId} |
324
+ *WorkItemsApi* | [**updateWorkItem**](WorkItemsApi.md#updateworkitemoperation) | **PATCH** /work-items/{id} |
325
+ *WorkflowsApi* | [**createWorkflow**](WorkflowsApi.md#createworkflowoperation) | **POST** /workflows |
326
+ *WorkflowsApi* | [**deleteWorkflow**](WorkflowsApi.md#deleteworkflow) | **DELETE** /workflows/{id} |
327
+ *WorkflowsApi* | [**getWorkflow**](WorkflowsApi.md#getworkflow) | **GET** /workflows/{id} |
328
+ *WorkflowsApi* | [**getWorkflowVersion**](WorkflowsApi.md#getworkflowversion) | **GET** /workflows/{id}/versions/{versionIdOrNumber} |
329
+ *WorkflowsApi* | [**listWorkflowVersions**](WorkflowsApi.md#listworkflowversions) | **GET** /workflows/{id}/versions |
330
+ *WorkflowsApi* | [**listWorkflows**](WorkflowsApi.md#listworkflows) | **GET** /workflows |
331
+ *WorkflowsApi* | [**revertWorkflow**](WorkflowsApi.md#revertworkflowoperation) | **POST** /workflows/{id}/revert |
332
+ *WorkflowsApi* | [**updateWorkflow**](WorkflowsApi.md#updateworkflowoperation) | **PATCH** /workflows/{id} |
333
+
334
+
335
+ ### Models
336
+
337
+ - [AddArtifactVersionRequest](AddArtifactVersionRequest.md)
338
+ - [AdminPortalLink](AdminPortalLink.md)
339
+ - [Agent](Agent.md)
340
+ - [AgentBehaviorSnapshot](AgentBehaviorSnapshot.md)
341
+ - [AgentMessageItem](AgentMessageItem.md)
342
+ - [AgentModelSettings](AgentModelSettings.md)
343
+ - [AgentStandbyStatus](AgentStandbyStatus.md)
344
+ - [AgentThoughtItem](AgentThoughtItem.md)
345
+ - [AgentVersion](AgentVersion.md)
346
+ - [Annotations](Annotations.md)
347
+ - [ApiError](ApiError.md)
348
+ - [ApiErrorDetail](ApiErrorDetail.md)
349
+ - [ApiKey](ApiKey.md)
350
+ - [ApiKeyWithToken](ApiKeyWithToken.md)
351
+ - [AppendSessionItemRequest](AppendSessionItemRequest.md)
352
+ - [AppendSessionItemResponse](AppendSessionItemResponse.md)
353
+ - [Artifact](Artifact.md)
354
+ - [ArtifactSummary](ArtifactSummary.md)
355
+ - [ArtifactVersion](ArtifactVersion.md)
356
+ - [ArtifactVersionDocument](ArtifactVersionDocument.md)
357
+ - [AssignAction](AssignAction.md)
358
+ - [AssignWorkItemRequest](AssignWorkItemRequest.md)
359
+ - [AudioContent](AudioContent.md)
360
+ - [AuthHandoff](AuthHandoff.md)
361
+ - [BackgroundTaskItem](BackgroundTaskItem.md)
362
+ - [BlobResourceContents](BlobResourceContents.md)
363
+ - [ChannelTarget](ChannelTarget.md)
364
+ - [CheckVote](CheckVote.md)
365
+ - [CheckWriter](CheckWriter.md)
366
+ - [CheckWriterPrincipal](CheckWriterPrincipal.md)
367
+ - [CheckWriterRule](CheckWriterRule.md)
368
+ - [ChosenStage](ChosenStage.md)
369
+ - [ClearCheckAction](ClearCheckAction.md)
370
+ - [CloseDependenciesAction](CloseDependenciesAction.md)
371
+ - [Comment](Comment.md)
372
+ - [CommentAnchor](CommentAnchor.md)
373
+ - [CommentSummary](CommentSummary.md)
374
+ - [CompleteFileUploadRequest](CompleteFileUploadRequest.md)
375
+ - [ComputeProvider](ComputeProvider.md)
376
+ - [ComputeProviderAzure](ComputeProviderAzure.md)
377
+ - [ComputeProviderHealth](ComputeProviderHealth.md)
378
+ - [ComputeProviderTarget](ComputeProviderTarget.md)
379
+ - [ComputeProviderWithKey](ComputeProviderWithKey.md)
380
+ - [Connection](Connection.md)
381
+ - [ConnectionAuth](ConnectionAuth.md)
382
+ - [ConnectionEventType](ConnectionEventType.md)
383
+ - [ConnectionIngestion](ConnectionIngestion.md)
384
+ - [ConnectionInstall](ConnectionInstall.md)
385
+ - [ConnectionInstallLink](ConnectionInstallLink.md)
386
+ - [ConnectionInstallLinkWithUrl](ConnectionInstallLinkWithUrl.md)
387
+ - [ConnectionWithEndpoint](ConnectionWithEndpoint.md)
388
+ - [Connector](Connector.md)
389
+ - [ContentBlock](ContentBlock.md)
390
+ - [CreateAgentRequest](CreateAgentRequest.md)
391
+ - [CreateApiKeyRequest](CreateApiKeyRequest.md)
392
+ - [CreateArtifactRequest](CreateArtifactRequest.md)
393
+ - [CreateAuthHandoffRequest](CreateAuthHandoffRequest.md)
394
+ - [CreateCommentRequest](CreateCommentRequest.md)
395
+ - [CreateComputeProviderRequest](CreateComputeProviderRequest.md)
396
+ - [CreateConnectionInstallLinkRequest](CreateConnectionInstallLinkRequest.md)
397
+ - [CreateConnectionRequest](CreateConnectionRequest.md)
398
+ - [CreateConnectorRequest](CreateConnectorRequest.md)
399
+ - [CreateDashboardRequest](CreateDashboardRequest.md)
400
+ - [CreateDecisionRequest](CreateDecisionRequest.md)
401
+ - [CreateEnvironmentRequest](CreateEnvironmentRequest.md)
402
+ - [CreateFileRequest](CreateFileRequest.md)
403
+ - [CreateGatewayKeyRequest](CreateGatewayKeyRequest.md)
404
+ - [CreateGroupRequest](CreateGroupRequest.md)
405
+ - [CreateMachineAccessTokenRequest](CreateMachineAccessTokenRequest.md)
406
+ - [CreateMachineEndpointRequest](CreateMachineEndpointRequest.md)
407
+ - [CreateMachineEnrollmentRequest](CreateMachineEnrollmentRequest.md)
408
+ - [CreateMachineRequest](CreateMachineRequest.md)
409
+ - [CreateMachineViewRequest](CreateMachineViewRequest.md)
410
+ - [CreateMetricRequest](CreateMetricRequest.md)
411
+ - [CreateModelAliasRequest](CreateModelAliasRequest.md)
412
+ - [CreateModelConfigRequest](CreateModelConfigRequest.md)
413
+ - [CreateModelProviderKeyRequest](CreateModelProviderKeyRequest.md)
414
+ - [CreateOrganizationInvitationRequest](CreateOrganizationInvitationRequest.md)
415
+ - [CreateOrganizationMembershipRequest](CreateOrganizationMembershipRequest.md)
416
+ - [CreateOrganizationRequest](CreateOrganizationRequest.md)
417
+ - [CreatePipelineRequest](CreatePipelineRequest.md)
418
+ - [CreatePipelineWorkflowRequest](CreatePipelineWorkflowRequest.md)
419
+ - [CreatePolicyRequest](CreatePolicyRequest.md)
420
+ - [CreateProjectRequest](CreateProjectRequest.md)
421
+ - [CreateProviderConnectionIntentRequest](CreateProviderConnectionIntentRequest.md)
422
+ - [CreateReplyRequest](CreateReplyRequest.md)
423
+ - [CreateRoleRequest](CreateRoleRequest.md)
424
+ - [CreateRoomTokenRequest](CreateRoomTokenRequest.md)
425
+ - [CreateSecretRequest](CreateSecretRequest.md)
426
+ - [CreateServiceAccountRequest](CreateServiceAccountRequest.md)
427
+ - [CreateSessionRequest](CreateSessionRequest.md)
428
+ - [CreateSkillRequest](CreateSkillRequest.md)
429
+ - [CreateTriggerRequest](CreateTriggerRequest.md)
430
+ - [CreateUserGrantRequest](CreateUserGrantRequest.md)
431
+ - [CreateUserRequest](CreateUserRequest.md)
432
+ - [CreateVolumeRequest](CreateVolumeRequest.md)
433
+ - [CreateWorkItemAction](CreateWorkItemAction.md)
434
+ - [CreateWorkItemActivityRequest](CreateWorkItemActivityRequest.md)
435
+ - [CreateWorkItemRequest](CreateWorkItemRequest.md)
436
+ - [CreateWorkflowRequest](CreateWorkflowRequest.md)
437
+ - [CredentialBinding](CredentialBinding.md)
438
+ - [CreditBalance](CreditBalance.md)
439
+ - [CreditLedgerEntry](CreditLedgerEntry.md)
440
+ - [CreditUsageBreakdownLine](CreditUsageBreakdownLine.md)
441
+ - [Dashboard](Dashboard.md)
442
+ - [DashboardChart](DashboardChart.md)
443
+ - [DashboardChartQuery](DashboardChartQuery.md)
444
+ - [Decision](Decision.md)
445
+ - [DecisionContext](DecisionContext.md)
446
+ - [DecisionContextPage](DecisionContextPage.md)
447
+ - [DecisionDraft](DecisionDraft.md)
448
+ - [DecisionEdit](DecisionEdit.md)
449
+ - [DecisionEditValue](DecisionEditValue.md)
450
+ - [DecisionError](DecisionError.md)
451
+ - [DecisionField](DecisionField.md)
452
+ - [DecisionOtherKind](DecisionOtherKind.md)
453
+ - [DecisionWords](DecisionWords.md)
454
+ - [Delivery](Delivery.md)
455
+ - [DependencyMove](DependencyMove.md)
456
+ - [EgressPolicyRule](EgressPolicyRule.md)
457
+ - [EmbeddedResourceResource](EmbeddedResourceResource.md)
458
+ - [EntitlementPeriodUsage](EntitlementPeriodUsage.md)
459
+ - [Environment](Environment.md)
460
+ - [EnvironmentDisk](EnvironmentDisk.md)
461
+ - [EnvironmentDiskMount](EnvironmentDiskMount.md)
462
+ - [EnvironmentEgressPolicy](EnvironmentEgressPolicy.md)
463
+ - [EnvironmentIngressPolicy](EnvironmentIngressPolicy.md)
464
+ - [EnvironmentMount](EnvironmentMount.md)
465
+ - [EnvironmentPlatform](EnvironmentPlatform.md)
466
+ - [EnvironmentPlatformRequest](EnvironmentPlatformRequest.md)
467
+ - [EnvironmentPlatformWithRuntime](EnvironmentPlatformWithRuntime.md)
468
+ - [EnvironmentProvisionSpec](EnvironmentProvisionSpec.md)
469
+ - [EnvironmentProvisionSpecRequest](EnvironmentProvisionSpecRequest.md)
470
+ - [EnvironmentResources](EnvironmentResources.md)
471
+ - [EnvironmentSharedVolumeMount](EnvironmentSharedVolumeMount.md)
472
+ - [EnvironmentSnapshot](EnvironmentSnapshot.md)
473
+ - [EnvironmentVolumeMount](EnvironmentVolumeMount.md)
474
+ - [EvaluateAction](EvaluateAction.md)
475
+ - [Event](Event.md)
476
+ - [Evidence](Evidence.md)
477
+ - [FileRef](FileRef.md)
478
+ - [FileWithUpload](FileWithUpload.md)
479
+ - [FilterNode](FilterNode.md)
480
+ - [FramePointAnchor](FramePointAnchor.md)
481
+ - [GatewayKey](GatewayKey.md)
482
+ - [GatewayKeyWithToken](GatewayKeyWithToken.md)
483
+ - [Group](Group.md)
484
+ - [GroupMember](GroupMember.md)
485
+ - [GroupMemberAgent](GroupMemberAgent.md)
486
+ - [GroupMemberReference](GroupMemberReference.md)
487
+ - [GroupMemberUser](GroupMemberUser.md)
488
+ - [GroupSummary](GroupSummary.md)
489
+ - [HealthStatus](HealthStatus.md)
490
+ - [IdentitySet](IdentitySet.md)
491
+ - [ImageContent](ImageContent.md)
492
+ - [InboundWebhookEdge](InboundWebhookEdge.md)
493
+ - [InboundWebhookEndpoint](InboundWebhookEndpoint.md)
494
+ - [IngressPolicyEndpoint](IngressPolicyEndpoint.md)
495
+ - [InjectionHeader](InjectionHeader.md)
496
+ - [InjectionRecipe](InjectionRecipe.md)
497
+ - [InterruptSessionRequest](InterruptSessionRequest.md)
498
+ - [InterruptSessionResponse](InterruptSessionResponse.md)
499
+ - [LauncherDisk](LauncherDisk.md)
500
+ - [LauncherInventory](LauncherInventory.md)
501
+ - [LauncherInventoryEntry](LauncherInventoryEntry.md)
502
+ - [LauncherMachineReport](LauncherMachineReport.md)
503
+ - [LauncherOrder](LauncherOrder.md)
504
+ - [LauncherPlatform](LauncherPlatform.md)
505
+ - [LauncherSize](LauncherSize.md)
506
+ - [LauncherTargetCheck](LauncherTargetCheck.md)
507
+ - [LauncherTargetRefusal](LauncherTargetRefusal.md)
508
+ - [LinkWorkItemRequest](LinkWorkItemRequest.md)
509
+ - [LoginStartRequest](LoginStartRequest.md)
510
+ - [LoginStartResult](LoginStartResult.md)
511
+ - [LogoutStartRequest](LogoutStartRequest.md)
512
+ - [LogoutStartResult](LogoutStartResult.md)
513
+ - [Machine](Machine.md)
514
+ - [MachineAccessToken](MachineAccessToken.md)
515
+ - [MachineAccessTokenWithSecret](MachineAccessTokenWithSecret.md)
516
+ - [MachineConnectionSummary](MachineConnectionSummary.md)
517
+ - [MachineDiagnostics](MachineDiagnostics.md)
518
+ - [MachineEgressPolicyDiagnostics](MachineEgressPolicyDiagnostics.md)
519
+ - [MachineEgressRuleDiagnostics](MachineEgressRuleDiagnostics.md)
520
+ - [MachineEndpoint](MachineEndpoint.md)
521
+ - [MachineEnrollment](MachineEnrollment.md)
522
+ - [MachineEnrollmentWithToken](MachineEnrollmentWithToken.md)
523
+ - [MachineHarnessFamily](MachineHarnessFamily.md)
524
+ - [MachineOperatorDiagnostics](MachineOperatorDiagnostics.md)
525
+ - [MachineOperatorRequest](MachineOperatorRequest.md)
526
+ - [MachineScreen](MachineScreen.md)
527
+ - [MachineSubstrateDiagnostics](MachineSubstrateDiagnostics.md)
528
+ - [MachineView](MachineView.md)
529
+ - [MachineViewAccessToken](MachineViewAccessToken.md)
530
+ - [MachineViewHolder](MachineViewHolder.md)
531
+ - [MatchedTarget](MatchedTarget.md)
532
+ - [MemberDisplay](MemberDisplay.md)
533
+ - [MemoryFile](MemoryFile.md)
534
+ - [MessageAction](MessageAction.md)
535
+ - [MessageTarget](MessageTarget.md)
536
+ - [MessageWorkItemRequest](MessageWorkItemRequest.md)
537
+ - [Metric](Metric.md)
538
+ - [MetricCategory](MetricCategory.md)
539
+ - [MetricConfig](MetricConfig.md)
540
+ - [MetricProjectionDescriptor](MetricProjectionDescriptor.md)
541
+ - [MetricRollup](MetricRollup.md)
542
+ - [MetricRollupBucket](MetricRollupBucket.md)
543
+ - [MetricRollupGroup](MetricRollupGroup.md)
544
+ - [MetricSubject](MetricSubject.md)
545
+ - [MetricValue](MetricValue.md)
546
+ - [MetricValueValue](MetricValueValue.md)
547
+ - [Model](Model.md)
548
+ - [ModelAlias](ModelAlias.md)
549
+ - [ModelConfig](ModelConfig.md)
550
+ - [ModelCreditRates](ModelCreditRates.md)
551
+ - [ModelFile](ModelFile.md)
552
+ - [ModelProvider](ModelProvider.md)
553
+ - [ModelProviderEndpoint](ModelProviderEndpoint.md)
554
+ - [ModelProviderKey](ModelProviderKey.md)
555
+ - [ModelRoute](ModelRoute.md)
556
+ - [MoveAction](MoveAction.md)
557
+ - [MoveWorkItemRequest](MoveWorkItemRequest.md)
558
+ - [MultipartUploadPart](MultipartUploadPart.md)
559
+ - [MultipartUploadPlan](MultipartUploadPlan.md)
560
+ - [OAuthError](OAuthError.md)
561
+ - [OAuthToken](OAuthToken.md)
562
+ - [OAuthTokenRequest](OAuthTokenRequest.md)
563
+ - [OAuthUser](OAuthUser.md)
564
+ - [ObjectLocator](ObjectLocator.md)
565
+ - [Organization](Organization.md)
566
+ - [OrganizationAccess](OrganizationAccess.md)
567
+ - [OrganizationAuthPolicy](OrganizationAuthPolicy.md)
568
+ - [OrganizationEntitlements](OrganizationEntitlements.md)
569
+ - [OrganizationInvitation](OrganizationInvitation.md)
570
+ - [OrganizationMembership](OrganizationMembership.md)
571
+ - [PageAgent](PageAgent.md)
572
+ - [PageAgentVersion](PageAgentVersion.md)
573
+ - [PageApiKey](PageApiKey.md)
574
+ - [PageArtifactSummary](PageArtifactSummary.md)
575
+ - [PageCommentSummary](PageCommentSummary.md)
576
+ - [PageComputeProvider](PageComputeProvider.md)
577
+ - [PageConnection](PageConnection.md)
578
+ - [PageConnectionInstallLink](PageConnectionInstallLink.md)
579
+ - [PageConnector](PageConnector.md)
580
+ - [PageCreditLedgerEntry](PageCreditLedgerEntry.md)
581
+ - [PageDashboard](PageDashboard.md)
582
+ - [PageDelivery](PageDelivery.md)
583
+ - [PageEnvironment](PageEnvironment.md)
584
+ - [PageEvent](PageEvent.md)
585
+ - [PageFile](PageFile.md)
586
+ - [PageGatewayKey](PageGatewayKey.md)
587
+ - [PageGroupSummary](PageGroupSummary.md)
588
+ - [PageMachine](PageMachine.md)
589
+ - [PageMachineAccessToken](PageMachineAccessToken.md)
590
+ - [PageMachineEnrollment](PageMachineEnrollment.md)
591
+ - [PageMachineView](PageMachineView.md)
592
+ - [PageMetric](PageMetric.md)
593
+ - [PageMetricValue](PageMetricValue.md)
594
+ - [PageModel](PageModel.md)
595
+ - [PageModelAlias](PageModelAlias.md)
596
+ - [PageModelConfig](PageModelConfig.md)
597
+ - [PageModelProvider](PageModelProvider.md)
598
+ - [PageModelProviderKey](PageModelProviderKey.md)
599
+ - [PageOrganization](PageOrganization.md)
600
+ - [PageOrganizationInvitation](PageOrganizationInvitation.md)
601
+ - [PageOrganizationMembership](PageOrganizationMembership.md)
602
+ - [PagePipeline](PagePipeline.md)
603
+ - [PagePolicy](PagePolicy.md)
604
+ - [PageProject](PageProject.md)
605
+ - [PageProviderConnectionIntent](PageProviderConnectionIntent.md)
606
+ - [PageRole](PageRole.md)
607
+ - [PageSecret](PageSecret.md)
608
+ - [PageServiceAccount](PageServiceAccount.md)
609
+ - [PageSessionSummary](PageSessionSummary.md)
610
+ - [PageSkill](PageSkill.md)
611
+ - [PageTrigger](PageTrigger.md)
612
+ - [PageUser](PageUser.md)
613
+ - [PageUserGrant](PageUserGrant.md)
614
+ - [PageVolume](PageVolume.md)
615
+ - [PageWorkItem](PageWorkItem.md)
616
+ - [PageWorkItemActivity](PageWorkItemActivity.md)
617
+ - [PageWorkflow](PageWorkflow.md)
618
+ - [PageWorkflowVersion](PageWorkflowVersion.md)
619
+ - [PatchArtifactDataRequest](PatchArtifactDataRequest.md)
620
+ - [Pin](Pin.md)
621
+ - [Pipeline](Pipeline.md)
622
+ - [PipelineRefusal](PipelineRefusal.md)
623
+ - [PipelineStage](PipelineStage.md)
624
+ - [PipelineSummary](PipelineSummary.md)
625
+ - [PipelineWorkflow](PipelineWorkflow.md)
626
+ - [PipelineWorkflowBuckets](PipelineWorkflowBuckets.md)
627
+ - [Plan](Plan.md)
628
+ - [PointAnchor](PointAnchor.md)
629
+ - [Policy](Policy.md)
630
+ - [PolicyAssignment](PolicyAssignment.md)
631
+ - [PolicyDocument](PolicyDocument.md)
632
+ - [PollComputeProviderRequest](PollComputeProviderRequest.md)
633
+ - [PollComputeProviderResponse](PollComputeProviderResponse.md)
634
+ - [Preferences](Preferences.md)
635
+ - [PreviewPipelineRequest](PreviewPipelineRequest.md)
636
+ - [PreviewPipelineResponse](PreviewPipelineResponse.md)
637
+ - [Principal](Principal.md)
638
+ - [Project](Project.md)
639
+ - [ProposedPipelineWorkflow](ProposedPipelineWorkflow.md)
640
+ - [Provider](Provider.md)
641
+ - [ProviderAutoRespondField](ProviderAutoRespondField.md)
642
+ - [ProviderClientField](ProviderClientField.md)
643
+ - [ProviderConnectionIntent](ProviderConnectionIntent.md)
644
+ - [ProviderConversation](ProviderConversation.md)
645
+ - [ProviderConversationLane](ProviderConversationLane.md)
646
+ - [ProviderConversationRefinement](ProviderConversationRefinement.md)
647
+ - [ProviderConversationSelfAuthorRule](ProviderConversationSelfAuthorRule.md)
648
+ - [ProviderDeliveryId](ProviderDeliveryId.md)
649
+ - [ProviderEventShape](ProviderEventShape.md)
650
+ - [ProviderGitPathRule](ProviderGitPathRule.md)
651
+ - [ProviderGitTransportShape](ProviderGitTransportShape.md)
652
+ - [ProviderInstallField](ProviderInstallField.md)
653
+ - [ProviderVerification](ProviderVerification.md)
654
+ - [RecordConnectionEventRequest](RecordConnectionEventRequest.md)
655
+ - [ReferenceSubject](ReferenceSubject.md)
656
+ - [Reply](Reply.md)
657
+ - [ReportComputeProviderRequest](ReportComputeProviderRequest.md)
658
+ - [Resource](Resource.md)
659
+ - [ResourceLink](ResourceLink.md)
660
+ - [ResumeMachineResponse](ResumeMachineResponse.md)
661
+ - [RevertWorkflowRequest](RevertWorkflowRequest.md)
662
+ - [Role](Role.md)
663
+ - [RoleAssignment](RoleAssignment.md)
664
+ - [RoomToken](RoomToken.md)
665
+ - [RoomTokenRoom](RoomTokenRoom.md)
666
+ - [RoomTokenRoomRequest](RoomTokenRoomRequest.md)
667
+ - [Rule](Rule.md)
668
+ - [RuleAction](RuleAction.md)
669
+ - [RuleFiringCount](RuleFiringCount.md)
670
+ - [RuleWhen](RuleWhen.md)
671
+ - [RuntimeImageMetadata](RuntimeImageMetadata.md)
672
+ - [RuntimeMetadata](RuntimeMetadata.md)
673
+ - [Secret](Secret.md)
674
+ - [SelectorAnchor](SelectorAnchor.md)
675
+ - [ServiceAccount](ServiceAccount.md)
676
+ - [Session](Session.md)
677
+ - [SessionItem](SessionItem.md)
678
+ - [SessionItemAuthor](SessionItemAuthor.md)
679
+ - [SessionProvisioning](SessionProvisioning.md)
680
+ - [SessionRuntimeSnapshot](SessionRuntimeSnapshot.md)
681
+ - [SessionSummary](SessionSummary.md)
682
+ - [SetCheckAction](SetCheckAction.md)
683
+ - [SetLabelsAction](SetLabelsAction.md)
684
+ - [SetWorkItemCheckRequest](SetWorkItemCheckRequest.md)
685
+ - [Skill](Skill.md)
686
+ - [SkillSnapshot](SkillSnapshot.md)
687
+ - [SnapshotAnchor](SnapshotAnchor.md)
688
+ - [StageChangePreview](StageChangePreview.md)
689
+ - [StageDefinition](StageDefinition.md)
690
+ - [StageItemCount](StageItemCount.md)
691
+ - [StageRemap](StageRemap.md)
692
+ - [StageSummary](StageSummary.md)
693
+ - [StandbyCapacity](StandbyCapacity.md)
694
+ - [StandbyCapacitySchedule](StandbyCapacitySchedule.md)
695
+ - [StandbyCapacityWindow](StandbyCapacityWindow.md)
696
+ - [StartedSession](StartedSession.md)
697
+ - [Statement](Statement.md)
698
+ - [StreamedViewStatus](StreamedViewStatus.md)
699
+ - [SuspendMachineRequest](SuspendMachineRequest.md)
700
+ - [SuspendMachineResponse](SuspendMachineResponse.md)
701
+ - [TextAnchor](TextAnchor.md)
702
+ - [TextContent](TextContent.md)
703
+ - [TextResourceContents](TextResourceContents.md)
704
+ - [TimeAnchor](TimeAnchor.md)
705
+ - [ToolCallContent](ToolCallContent.md)
706
+ - [ToolCallContentBlock](ToolCallContentBlock.md)
707
+ - [ToolCallDiff](ToolCallDiff.md)
708
+ - [ToolCallItem](ToolCallItem.md)
709
+ - [ToolCallLocation](ToolCallLocation.md)
710
+ - [ToolCallTerminal](ToolCallTerminal.md)
711
+ - [Trigger](Trigger.md)
712
+ - [TriggerOn](TriggerOn.md)
713
+ - [TriggerTarget](TriggerTarget.md)
714
+ - [TurnStartItem](TurnStartItem.md)
715
+ - [UpdateAgentRequest](UpdateAgentRequest.md)
716
+ - [UpdateArtifactRequest](UpdateArtifactRequest.md)
717
+ - [UpdateCommentRequest](UpdateCommentRequest.md)
718
+ - [UpdateComputeProviderRequest](UpdateComputeProviderRequest.md)
719
+ - [UpdateConnectionRequest](UpdateConnectionRequest.md)
720
+ - [UpdateConnectorRequest](UpdateConnectorRequest.md)
721
+ - [UpdateDashboardRequest](UpdateDashboardRequest.md)
722
+ - [UpdateEnvironmentRequest](UpdateEnvironmentRequest.md)
723
+ - [UpdateGatewayKeyRequest](UpdateGatewayKeyRequest.md)
724
+ - [UpdateGroupRequest](UpdateGroupRequest.md)
725
+ - [UpdateMetricRequest](UpdateMetricRequest.md)
726
+ - [UpdateModelAliasRequest](UpdateModelAliasRequest.md)
727
+ - [UpdateModelConfigRequest](UpdateModelConfigRequest.md)
728
+ - [UpdateModelProviderKeyRequest](UpdateModelProviderKeyRequest.md)
729
+ - [UpdateOrganizationInvitationRequest](UpdateOrganizationInvitationRequest.md)
730
+ - [UpdateOrganizationMembershipRequest](UpdateOrganizationMembershipRequest.md)
731
+ - [UpdateOrganizationRequest](UpdateOrganizationRequest.md)
732
+ - [UpdatePipelineRequest](UpdatePipelineRequest.md)
733
+ - [UpdatePipelineWorkflowRequest](UpdatePipelineWorkflowRequest.md)
734
+ - [UpdatePolicyRequest](UpdatePolicyRequest.md)
735
+ - [UpdatePreferencesRequest](UpdatePreferencesRequest.md)
736
+ - [UpdateProjectRequest](UpdateProjectRequest.md)
737
+ - [UpdateReplyRequest](UpdateReplyRequest.md)
738
+ - [UpdateRoleRequest](UpdateRoleRequest.md)
739
+ - [UpdateSecretRequest](UpdateSecretRequest.md)
740
+ - [UpdateServiceAccountRequest](UpdateServiceAccountRequest.md)
741
+ - [UpdateSessionRequest](UpdateSessionRequest.md)
742
+ - [UpdateSkillRequest](UpdateSkillRequest.md)
743
+ - [UpdateTriggerRequest](UpdateTriggerRequest.md)
744
+ - [UpdateUserRequest](UpdateUserRequest.md)
745
+ - [UpdateVolumeRequest](UpdateVolumeRequest.md)
746
+ - [UpdateWorkItemRequest](UpdateWorkItemRequest.md)
747
+ - [UpdateWorkflowRequest](UpdateWorkflowRequest.md)
748
+ - [UploadedPart](UploadedPart.md)
749
+ - [User](User.md)
750
+ - [UserGrant](UserGrant.md)
751
+ - [UserGrantAuthorization](UserGrantAuthorization.md)
752
+ - [UserMessageItem](UserMessageItem.md)
753
+ - [Volume](Volume.md)
754
+ - [WaitingPageSessionItem](WaitingPageSessionItem.md)
755
+ - [WebhookEdgeCommandRequest](WebhookEdgeCommandRequest.md)
756
+ - [WorkItem](WorkItem.md)
757
+ - [WorkItemActivity](WorkItemActivity.md)
758
+ - [WorkItemAssignment](WorkItemAssignment.md)
759
+ - [WorkItemChange](WorkItemChange.md)
760
+ - [WorkItemCheck](WorkItemCheck.md)
761
+ - [WorkItemDraft](WorkItemDraft.md)
762
+ - [WorkItemDraftAssignment](WorkItemDraftAssignment.md)
763
+ - [WorkItemRelationSummary](WorkItemRelationSummary.md)
764
+ - [WorkItemRelations](WorkItemRelations.md)
765
+ - [Workflow](Workflow.md)
766
+ - [WorkflowOverlap](WorkflowOverlap.md)
767
+ - [WorkflowOverlapEntry](WorkflowOverlapEntry.md)
768
+ - [WorkflowOverlapRules](WorkflowOverlapRules.md)
769
+ - [WorkflowSummary](WorkflowSummary.md)
770
+ - [WorkflowVersion](WorkflowVersion.md)
771
+ - [WriteMetricValueRequest](WriteMetricValueRequest.md)
772
+ - [WriteMetricValueRequestValue](WriteMetricValueRequestValue.md)
773
+
774
+ ### Authorization
775
+
776
+
777
+ Authentication schemes defined for the API:
778
+ <a id="bearerAuth"></a>
779
+ #### bearerAuth
780
+
781
+
782
+ - **Type**: HTTP Bearer Token authentication (JWT)
783
+
784
+ ## About
785
+
786
+ This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
787
+ and is automatically generated by the
788
+ [OpenAPI Generator](https://openapi-generator.tech) project:
789
+
790
+ - API version: `0.1.0`
791
+ - Package version: `0.5.1`
792
+ - Generator version: `7.22.0`
793
+ - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
794
+
795
+ The generated npm module supports the following:
796
+
797
+ - Environments
798
+ * Node.js
799
+ * Webpack
800
+ * Browserify
801
+ - Language levels
802
+ * ES5 - you must have a Promises/A+ library installed
803
+ * ES6
804
+ - Module systems
805
+ * CommonJS
806
+ * ES6 module system
807
+
808
+
809
+ ## Development
810
+
811
+ ### Building
812
+
813
+ To build the TypeScript source code, you need to have Node.js and npm installed.
814
+ After cloning the repository, navigate to the project directory and run:
815
+
816
+ ```bash
817
+ npm install
818
+ npm run build
819
+ ```
820
+
821
+ ### Publishing
822
+
823
+ Once you've built the package, you can publish it to npm:
824
+
825
+ ```bash
826
+ npm publish
827
+ ```
828
+
829
+ ## License
830
+
831
+ `@orchestraworks/client` is released under the [Apache License 2.0](../LICENSE) — the full text ships in this package.
832
+
833
+ Copyright 2026 Living Computers