orvanta-api 4.1.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

# \CopilotConversationsApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**append_copilot_conversation_messages**](CopilotConversationsApi.md#append_copilot_conversation_messages) | **POST** /w/{workspace}/copilot_conversations/{conversation_id}/messages | append messages to a copilot conversation
[**create_copilot_conversation**](CopilotConversationsApi.md#create_copilot_conversation) | **POST** /w/{workspace}/copilot_conversations/create | create or update a copilot conversation
[**delete_copilot_conversation**](CopilotConversationsApi.md#delete_copilot_conversation) | **DELETE** /w/{workspace}/copilot_conversations/delete/{conversation_id} | delete copilot conversation
[**get_copilot_conversation**](CopilotConversationsApi.md#get_copilot_conversation) | **GET** /w/{workspace}/copilot_conversations/get/{conversation_id} | get copilot conversation
[**list_copilot_conversation_messages**](CopilotConversationsApi.md#list_copilot_conversation_messages) | **GET** /w/{workspace}/copilot_conversations/{conversation_id}/messages | list copilot conversation messages
[**list_copilot_conversation_shares**](CopilotConversationsApi.md#list_copilot_conversation_shares) | **GET** /w/{workspace}/copilot_conversations/{conversation_id}/shares | list who a copilot conversation is shared with
[**list_copilot_conversations**](CopilotConversationsApi.md#list_copilot_conversations) | **GET** /w/{workspace}/copilot_conversations/list | list copilot conversations
[**list_copilot_conversations_shared_with_me**](CopilotConversationsApi.md#list_copilot_conversations_shared_with_me) | **GET** /w/{workspace}/copilot_conversations/shared_with_me | list copilot conversations shared with me
[**share_copilot_conversation**](CopilotConversationsApi.md#share_copilot_conversation) | **POST** /w/{workspace}/copilot_conversations/{conversation_id}/shares | share a copilot conversation with a colleague
[**unshare_copilot_conversation**](CopilotConversationsApi.md#unshare_copilot_conversation) | **DELETE** /w/{workspace}/copilot_conversations/{conversation_id}/shares/{username} | revoke a copilot conversation share



## append_copilot_conversation_messages

> models::AppendCopilotConversationMessages200Response append_copilot_conversation_messages(workspace, conversation_id, append_copilot_conversation_messages_request)
append messages to a copilot conversation

Author-only. A workspace admin that can read a transcript still gets a 404 here — read power and write power are deliberately separate so an audited transcript cannot be forged.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**conversation_id** | **uuid::Uuid** |  | [required] |
**append_copilot_conversation_messages_request** | [**AppendCopilotConversationMessagesRequest**](AppendCopilotConversationMessagesRequest.md) |  | [required] |

### Return type

[**models::AppendCopilotConversationMessages200Response**](appendCopilotConversationMessages_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_copilot_conversation

> models::CopilotConversation create_copilot_conversation(workspace, create_copilot_conversation_request)
create or update a copilot conversation

Idempotent upsert on a client-minted UUID, so a retry is safe. `messages` is normally empty (messages are appended per turn) and non-empty only on the one-time IndexedDB import. Re-using an id owned by someone else is refused rather than rebound.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**create_copilot_conversation_request** | [**CreateCopilotConversationRequest**](CreateCopilotConversationRequest.md) |  | [required] |

### Return type

[**models::CopilotConversation**](CopilotConversation.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_copilot_conversation

> String delete_copilot_conversation(workspace, conversation_id)
delete copilot conversation

Author or workspace admin. Messages cascade. Always audit-logged — this is the erasure path for content a user may have pasted a secret into.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**conversation_id** | **uuid::Uuid** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_copilot_conversation

> models::CopilotConversation get_copilot_conversation(workspace, conversation_id)
get copilot conversation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**conversation_id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::CopilotConversation**](CopilotConversation.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_copilot_conversation_messages

> Vec<models::CopilotConversationMessage> list_copilot_conversation_messages(workspace, conversation_id, page, per_page, after_seq, channel)
list copilot conversation messages

The author's own transcript is returned verbatim, byte-exact, because the `actual` channel is replayed to the model on resume. When a workspace admin reads **somebody else's** transcript (#1282), string leaves that match a known credential shape are replaced with `[orvanta:redacted]` in the response. That masking is best-effort pattern matching, not a guarantee: it catches PEM key blocks, URL userinfo, labelled `secret=`/`api_key:` assignments and a handful of prefixed vendor tokens, and it does **not** catch a bare unlabelled high-entropy string, an encoded secret, or a secret split across messages. Treat a masked transcript as still sensitive.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**conversation_id** | **uuid::Uuid** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**after_seq** | Option<**i64**> | resume cursor — return only messages after this created_seq |  |
**channel** | Option<**String**> | restrict to one stream |  |

### Return type

[**Vec<models::CopilotConversationMessage>**](CopilotConversationMessage.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_copilot_conversation_shares

> Vec<models::CopilotConversationShare> list_copilot_conversation_shares(workspace, conversation_id)
list who a copilot conversation is shared with

Author, or a workspace admin (audited as `copilot_conversations.audit_read`). Deliberately not the recipients — telling one recipient who else has access discloses those people without their involvement.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**conversation_id** | **uuid::Uuid** |  | [required] |

### Return type

[**Vec<models::CopilotConversationShare>**](CopilotConversationShare.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_copilot_conversations

> Vec<models::CopilotConversation> list_copilot_conversations(workspace, page, per_page, include_all_users, created_by, mode)
list copilot conversations

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**include_all_users** | Option<**bool**> | Return every author's conversations in the workspace instead of only your own. Workspace admin only (403 otherwise) and audit-logged as `copilot_conversations.audit_list`. |  |
**created_by** | Option<**String**> | Return one named author's conversations. Naming yourself is always allowed; naming anyone else requires workspace admin and is audited. |  |
**mode** | Option<**String**> | filter by copilot mode |  |

### Return type

[**Vec<models::CopilotConversation>**](CopilotConversation.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_copilot_conversations_shared_with_me

> Vec<models::SharedCopilotConversation> list_copilot_conversations_shared_with_me(workspace, page, per_page)
list copilot conversations shared with me

The recipient's inbox. Each entry carries `shared_by` — the authenticated identity that issued the grant — alongside the conversation's own `created_by`, which is an attribution recorded at save time and not a proof of authorship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::SharedCopilotConversation>**](SharedCopilotConversation.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## share_copilot_conversation

> models::CopilotConversationShare share_copilot_conversation(workspace, conversation_id, create_service_account_request)
share a copilot conversation with a colleague

Author-only, and idempotent: re-granting the same pair returns the existing grant without re-dating it or writing a second audit row. A workspace admin gets the same 404 as anyone else — a share is the author's consent that a colleague may read what they typed, and an admin issuing it on their behalf manufactures that consent. The recipient must be an active member of this workspace. Audit-logged as `copilot_conversations.share`.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**conversation_id** | **uuid::Uuid** |  | [required] |
**create_service_account_request** | [**CreateServiceAccountRequest**](CreateServiceAccountRequest.md) |  | [required] |

### Return type

[**models::CopilotConversationShare**](CopilotConversationShare.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## unshare_copilot_conversation

> String unshare_copilot_conversation(workspace, conversation_id, username)
revoke a copilot conversation share

Author or workspace admin, and idempotent. Revocation is **prospective**: it stops future reads through this API, it does not un-read — a recipient who already opened the transcript has seen it and may have copied it. Audit-logged as `copilot_conversations.unshare`.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**conversation_id** | **uuid::Uuid** |  | [required] |
**username** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)