Class: LiteLLMClient::TeamManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/api/team_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TeamManagementApi

Returns a new instance of TeamManagementApi.



19
20
21
 
# File 'lib/litellm_client/api/team_management_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/litellm_client/api/team_management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_team_callbacks_team_team_id_callback_post(team_id, add_team_callback, opts = {}) ⇒ Object

Add Team Callbacks Add a success/failure callback to a team Use this if if you want different teams to have different success/failure callbacks Parameters: - callback_name (Literal["langfuse", "langsmith", "gcs"], required): The name of the callback to add - callback_type (Literal["success", "failure", "success_and_failure"], required): The type of callback to add. One of: - "success": Callback for successful LLM calls - "failure": Callback for failed LLM calls - "success_and_failure": Callback for both successful and failed LLM calls - callback_vars (StandardCallbackDynamicParams, required): A dictionary of variables to pass to the callback - langfuse_public_key: The public key for the Langfuse callback - langfuse_secret_key: The secret key for the Langfuse callback - langfuse_secret: The secret for the Langfuse callback - langfuse_host: The host for the Langfuse callback - gcs_bucket_name: The name of the GCS bucket - gcs_path_service_account: The path to the GCS service account - langsmith_api_key: The API key for the Langsmith callback - langsmith_project: The project for the Langsmith callback - langsmith_base_url: The base URL for the Langsmith callback Example curl: “‘ curl -X POST ’localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/callback’ -H ‘Content-Type: application/json’ -H ‘Authorization: Bearer sk-1234’ -d ‘{ "callback_name": "langfuse", "callback_type": "success", "callback_vars": "pk-lf-xxxx1", "langfuse_secret_key": "sk-xxxxx" }’ “‘ This means for the team where team_id = dbe2f686-a686-4896-864a-4c3924458709, all LLM calls will be logged to langfuse using the public key pk-lf-xxxx1 and the secret key sk-xxxxx

Parameters:

  • team_id (String)
  • add_team_callback (AddTeamCallback)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/litellm_client/api/team_management_api.rb', line 29

def add_team_callbacks_team_team_id_callback_post(team_id, add_team_callback, opts = {})
  data, _status_code, _headers = add_team_callbacks_team_team_id_callback_post_with_http_info(team_id, add_team_callback, opts)
  data
end

#add_team_callbacks_team_team_id_callback_post_with_http_info(team_id, add_team_callback, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Add Team Callbacks Add a success/failure callback to a team Use this if if you want different teams to have different success/failure callbacks Parameters: - callback_name (Literal[&quot;langfuse&quot;, &quot;langsmith&quot;, &quot;gcs&quot;], required): The name of the callback to add - callback_type (Literal[&quot;success&quot;, &quot;failure&quot;, &quot;success_and_failure&quot;], required): The type of callback to add. One of: - &quot;success&quot;: Callback for successful LLM calls - &quot;failure&quot;: Callback for failed LLM calls - &quot;success_and_failure&quot;: Callback for both successful and failed LLM calls - callback_vars (StandardCallbackDynamicParams, required): A dictionary of variables to pass to the callback - langfuse_public_key: The public key for the Langfuse callback - langfuse_secret_key: The secret key for the Langfuse callback - langfuse_secret: The secret for the Langfuse callback - langfuse_host: The host for the Langfuse callback - gcs_bucket_name: The name of the GCS bucket - gcs_path_service_account: The path to the GCS service account - langsmith_api_key: The API key for the Langsmith callback - langsmith_project: The project for the Langsmith callback - langsmith_base_url: The base URL for the Langsmith callback Example curl: &#x60;&#x60;&#x60; curl -X POST &#39;localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/callback&#39; -H &#39;Content-Type: application/json&#39; -H &#39;Authorization: Bearer sk-1234&#39; -d &#39;{ &quot;callback_name&quot;: &quot;langfuse&quot;, &quot;callback_type&quot;: &quot;success&quot;, &quot;callback_vars&quot;: &quot;pk-lf-xxxx1&quot;, &quot;langfuse_secret_key&quot;: &quot;sk-xxxxx&quot; }&#39; &#x60;&#x60;&#x60; This means for the team where team_id &#x3D; dbe2f686-a686-4896-864a-4c3924458709, all LLM calls will be logged to langfuse using the public key pk-lf-xxxx1 and the secret key sk-xxxxx

Parameters:

  • team_id (String)
  • add_team_callback (AddTeamCallback)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
 
# File 'lib/litellm_client/api/team_management_api.rb', line 41

def add_team_callbacks_team_team_id_callback_post_with_http_info(team_id, add_team_callback, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.add_team_callbacks_team_team_id_callback_post ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamManagementApi.add_team_callbacks_team_team_id_callback_post"
  end
  # verify the required parameter 'add_team_callback' is set
  if @api_client.config.client_side_validation && add_team_callback.nil?
    fail ArgumentError, "Missing the required parameter 'add_team_callback' when calling TeamManagementApi.add_team_callbacks_team_team_id_callback_post"
  end
  # resource path
  local_var_path = '/team/{team_id}/callback'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'litellm-changed-by'] = opts[:'litellm_changed_by'] if !opts[:'litellm_changed_by'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(add_team_callback)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.add_team_callbacks_team_team_id_callback_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#add_team_callbacks_team_team_id_callback_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#block_team_team_block_post(block_team_request, opts = {}) ⇒ Object

Block Team Blocks all calls from keys with this team id. Parameters: - team_id: str - Required. The unique identifier of the team to block. Example: “‘ curl –location ’0.0.0.0:4000/team/block’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data ‘{ "team_id": "team-1234" }’ “‘ Returns: - The updated team record with blocked=True

Parameters:

  • block_team_request (BlockTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


104
105
106
107
 
# File 'lib/litellm_client/api/team_management_api.rb', line 104

def block_team_team_block_post(block_team_request, opts = {})
  data, _status_code, _headers = block_team_team_block_post_with_http_info(block_team_request, opts)
  data
end

#block_team_team_block_post_with_http_info(block_team_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Block Team Blocks all calls from keys with this team id. Parameters: - team_id: str - Required. The unique identifier of the team to block. Example: &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/block&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data &#39;{ &quot;team_id&quot;: &quot;team-1234&quot; }&#39; &#x60;&#x60;&#x60; Returns: - The updated team record with blocked&#x3D;True

Parameters:

  • block_team_request (BlockTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
 
# File 'lib/litellm_client/api/team_management_api.rb', line 114

def block_team_team_block_post_with_http_info(block_team_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.block_team_team_block_post ...'
  end
  # verify the required parameter 'block_team_request' is set
  if @api_client.config.client_side_validation && block_team_request.nil?
    fail ArgumentError, "Missing the required parameter 'block_team_request' when calling TeamManagementApi.block_team_team_block_post"
  end
  # resource path
  local_var_path = '/team/block'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(block_team_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.block_team_team_block_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#block_team_team_block_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_team_team_delete_post(delete_team_request, opts = {}) ⇒ Object

Delete Team delete team and associated team keys Parameters: - team_ids: List - Required. List of team IDs to delete. Example: ["team-1234", "team-5678"] “‘ curl –location ’0.0.0.0:4000/team/delete’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data-raw ‘{ "team_ids": ["8d916b1c-510d-4894-a334-1c16a93344f5"] }’ “‘

Parameters:

  • delete_team_request (DeleteTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:

  • (Object) 


173
174
175
176
 
# File 'lib/litellm_client/api/team_management_api.rb', line 173

def delete_team_team_delete_post(delete_team_request, opts = {})
  data, _status_code, _headers = delete_team_team_delete_post_with_http_info(delete_team_request, opts)
  data
end

#delete_team_team_delete_post_with_http_info(delete_team_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Team delete team and associated team keys Parameters: - team_ids: List - Required. List of team IDs to delete. Example: [&quot;team-1234&quot;, &quot;team-5678&quot;] &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/delete&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data-raw &#39;{ &quot;team_ids&quot;: [&quot;8d916b1c-510d-4894-a334-1c16a93344f5&quot;] }&#39; &#x60;&#x60;&#x60;

Parameters:

  • delete_team_request (DeleteTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
 
# File 'lib/litellm_client/api/team_management_api.rb', line 184

def delete_team_team_delete_post_with_http_info(delete_team_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.delete_team_team_delete_post ...'
  end
  # verify the required parameter 'delete_team_request' is set
  if @api_client.config.client_side_validation && delete_team_request.nil?
    fail ArgumentError, "Missing the required parameter 'delete_team_request' when calling TeamManagementApi.delete_team_team_delete_post"
  end
  # resource path
  local_var_path = '/team/delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'litellm-changed-by'] = opts[:'litellm_changed_by'] if !opts[:'litellm_changed_by'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_team_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.delete_team_team_delete_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#delete_team_team_delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#disable_team_logging_team_team_id_disable_logging_post(team_id, opts = {}) ⇒ Object

Disable Team Logging Disable all logging callbacks for a team Parameters: - team_id (str, required): The unique identifier for the team Example curl: “‘ curl -X POST ’localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/disable_logging’ -H ‘Authorization: Bearer sk-1234’ “‘

Parameters:

  • team_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


243
244
245
246
 
# File 'lib/litellm_client/api/team_management_api.rb', line 243

def disable_team_logging_team_team_id_disable_logging_post(team_id, opts = {})
  data, _status_code, _headers = disable_team_logging_team_team_id_disable_logging_post_with_http_info(team_id, opts)
  data
end

#disable_team_logging_team_team_id_disable_logging_post_with_http_info(team_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Disable Team Logging Disable all logging callbacks for a team Parameters: - team_id (str, required): The unique identifier for the team Example curl: &#x60;&#x60;&#x60; curl -X POST &#39;localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/disable_logging&#39; -H &#39;Authorization: Bearer sk-1234&#39; &#x60;&#x60;&#x60;

Parameters:

  • team_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
 
# File 'lib/litellm_client/api/team_management_api.rb', line 253

def disable_team_logging_team_team_id_disable_logging_post_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.disable_team_logging_team_team_id_disable_logging_post ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamManagementApi.disable_team_logging_team_team_id_disable_logging_post"
  end
  # resource path
  local_var_path = '/team/{team_id}/disable_logging'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.disable_team_logging_team_team_id_disable_logging_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#disable_team_logging_team_team_id_disable_logging_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_team_callbacks_team_team_id_callback_get(team_id, opts = {}) ⇒ Object

Get Team Callbacks Get the success/failure callbacks and variables for a team Parameters: - team_id (str, required): The unique identifier for the team Example curl: “‘ curl -X GET ’localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/callback’ -H ‘Authorization: Bearer sk-1234’ “‘ This will return the callback settings for the team with id dbe2f686-a686-4896-864a-4c3924458709 Returns { "status": "success", "data": { "team_id": team_id, "success_callbacks": team_callback_settings_obj.success_callback, "failure_callbacks": team_callback_settings_obj.failure_callback, "callback_vars": team_callback_settings_obj.callback_vars, }, }

Parameters:

  • team_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


306
307
308
309
 
# File 'lib/litellm_client/api/team_management_api.rb', line 306

def get_team_callbacks_team_team_id_callback_get(team_id, opts = {})
  data, _status_code, _headers = get_team_callbacks_team_team_id_callback_get_with_http_info(team_id, opts)
  data
end

#get_team_callbacks_team_team_id_callback_get_with_http_info(team_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Team Callbacks Get the success/failure callbacks and variables for a team Parameters: - team_id (str, required): The unique identifier for the team Example curl: &#x60;&#x60;&#x60; curl -X GET &#39;localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/callback&#39; -H &#39;Authorization: Bearer sk-1234&#39; &#x60;&#x60;&#x60; This will return the callback settings for the team with id dbe2f686-a686-4896-864a-4c3924458709 Returns { &quot;status&quot;: &quot;success&quot;, &quot;data&quot;: { &quot;team_id&quot;: team_id, &quot;success_callbacks&quot;: team_callback_settings_obj.success_callback, &quot;failure_callbacks&quot;: team_callback_settings_obj.failure_callback, &quot;callback_vars&quot;: team_callback_settings_obj.callback_vars, }, }

Parameters:

  • team_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/litellm_client/api/team_management_api.rb', line 316

def get_team_callbacks_team_team_id_callback_get_with_http_info(team_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.get_team_callbacks_team_team_id_callback_get ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamManagementApi.get_team_callbacks_team_team_id_callback_get"
  end
  # resource path
  local_var_path = '/team/{team_id}/callback'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.get_team_callbacks_team_team_id_callback_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#get_team_callbacks_team_team_id_callback_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_team_daily_activity_team_daily_activity_get(opts = {}) ⇒ SpendAnalyticsPaginatedResponse

Get Team Daily Activity Get daily activity for specific teams or all teams. Args: team_ids (Optional): Comma-separated list of team IDs to filter by. If not provided, returns data for all teams. start_date (Optional): Start date for the activity period (YYYY-MM-DD). end_date (Optional): End date for the activity period (YYYY-MM-DD). model (Optional): Filter by model name. api_key (Optional): Filter by API key. page (int): Page number for pagination. page_size (int): Number of items per page. exclude_team_ids (Optional): Comma-separated list of team IDs to exclude. Returns: SpendAnalyticsPaginatedResponse: Paginated response containing daily activity data.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_ids (String)
  • :start_date (String)
  • :end_date (String)
  • :model (String)
  • :api_key (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 10
  • :exclude_team_ids (String)

Returns:



376
377
378
379
 
# File 'lib/litellm_client/api/team_management_api.rb', line 376

def get_team_daily_activity_team_daily_activity_get(opts = {})
  data, _status_code, _headers = get_team_daily_activity_team_daily_activity_get_with_http_info(opts)
  data
end

#get_team_daily_activity_team_daily_activity_get_with_http_info(opts = {}) ⇒ Array<(SpendAnalyticsPaginatedResponse, Integer, Hash)>

Get Team Daily Activity Get daily activity for specific teams or all teams. Args: team_ids (Optional): Comma-separated list of team IDs to filter by. If not provided, returns data for all teams. start_date (Optional): Start date for the activity period (YYYY-MM-DD). end_date (Optional): End date for the activity period (YYYY-MM-DD). model (Optional): Filter by model name. api_key (Optional): Filter by API key. page (int): Page number for pagination. page_size (int): Number of items per page. exclude_team_ids (Optional): Comma-separated list of team IDs to exclude. Returns: SpendAnalyticsPaginatedResponse: Paginated response containing daily activity data.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_ids (String)
  • :start_date (String)
  • :end_date (String)
  • :model (String)
  • :api_key (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 10
  • :exclude_team_ids (String)

Returns:



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/litellm_client/api/team_management_api.rb', line 393

def get_team_daily_activity_team_daily_activity_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.get_team_daily_activity_team_daily_activity_get ...'
  end
  # resource path
  local_var_path = '/team/daily/activity'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'team_ids'] = opts[:'team_ids'] if !opts[:'team_ids'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
  query_params[:'api_key'] = opts[:'api_key'] if !opts[:'api_key'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'exclude_team_ids'] = opts[:'exclude_team_ids'] if !opts[:'exclude_team_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SpendAnalyticsPaginatedResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.get_team_daily_activity_team_daily_activity_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#get_team_daily_activity_team_daily_activity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_team_team_list_get(opts = {}) ⇒ Object

List Team “‘ curl –location –request GET ’0.0.0.0:4000/team/list’ –header ‘Authorization: Bearer sk-1234’ “‘ Parameters: - user_id: str - Optional. If passed will only return teams that the user_id is a member of. - organization_id: str - Optional. If passed will only return teams that belong to the organization_id. Pass ’default_organization’ to get all teams without organization_id.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    Only return teams which this &#39;user_id&#39; belongs to

  • :organization_id (String)

Returns:

  • (Object) 


451
452
453
454
 
# File 'lib/litellm_client/api/team_management_api.rb', line 451

def list_team_team_list_get(opts = {})
  data, _status_code, _headers = list_team_team_list_get_with_http_info(opts)
  data
end

#list_team_team_list_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List Team &#x60;&#x60;&#x60; curl –location –request GET &#39;0.0.0.0:4000/team/list&#39; –header &#39;Authorization: Bearer sk-1234&#39; &#x60;&#x60;&#x60; Parameters: - user_id: str - Optional. If passed will only return teams that the user_id is a member of. - organization_id: str - Optional. If passed will only return teams that belong to the organization_id. Pass &#39;default_organization&#39; to get all teams without organization_id.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    Only return teams which this &#39;user_id&#39; belongs to

  • :organization_id (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/litellm_client/api/team_management_api.rb', line 462

def list_team_team_list_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.list_team_team_list_get ...'
  end
  # resource path
  local_var_path = '/team/list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'organization_id'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.list_team_team_list_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#list_team_team_list_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_team_v2_v2_team_list_get(opts = {}) ⇒ TeamListResponse

List Team V2 Get a paginated list of teams with filtering and sorting options. Parameters: user_id: Optional Only return teams which this user belongs to organization_id: Optional Only return teams which belong to this organization team_id: Optional Filter teams by exact team_id match team_alias: Optional Filter teams by partial team_alias match page: int The page number to return page_size: int The number of items per page sort_by: Optional Column to sort by (e.g. ‘team_id’, ‘team_alias’, ‘created_at’) sort_order: str Sort order (‘asc’ or ‘desc’)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    Only return teams which this &#39;user_id&#39; belongs to

  • :organization_id (String) —

    Only return teams which this &#39;organization_id&#39; belongs to

  • :team_id (String) —

    Only return teams which this &#39;team_id&#39; belongs to

  • :team_alias (String) —

    Only return teams which this &#39;team_alias&#39; belongs to. Supports partial matching.

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :page_size (Integer) —

    Number of teams per page (default to 10)

  • :sort_by (String) —

    Column to sort by (e.g. &#39;team_id&#39;, &#39;team_alias&#39;, &#39;created_at&#39;)

  • :sort_order (String) —

    Sort order (&#39;asc&#39; or &#39;desc&#39;) (default to ‘asc’)

Returns:



520
521
522
523
 
# File 'lib/litellm_client/api/team_management_api.rb', line 520

def list_team_v2_v2_team_list_get(opts = {})
  data, _status_code, _headers = list_team_v2_v2_team_list_get_with_http_info(opts)
  data
end

#list_team_v2_v2_team_list_get_with_http_info(opts = {}) ⇒ Array<(TeamListResponse, Integer, Hash)>

List Team V2 Get a paginated list of teams with filtering and sorting options. Parameters: user_id: Optional Only return teams which this user belongs to organization_id: Optional Only return teams which belong to this organization team_id: Optional Filter teams by exact team_id match team_alias: Optional Filter teams by partial team_alias match page: int The page number to return page_size: int The number of items per page sort_by: Optional Column to sort by (e.g. &#39;team_id&#39;, &#39;team_alias&#39;, &#39;created_at&#39;) sort_order: str Sort order (&#39;asc&#39; or &#39;desc&#39;)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    Only return teams which this &#39;user_id&#39; belongs to

  • :organization_id (String) —

    Only return teams which this &#39;organization_id&#39; belongs to

  • :team_id (String) —

    Only return teams which this &#39;team_id&#39; belongs to

  • :team_alias (String) —

    Only return teams which this &#39;team_alias&#39; belongs to. Supports partial matching.

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :page_size (Integer) —

    Number of teams per page (default to 10)

  • :sort_by (String) —

    Column to sort by (e.g. &#39;team_id&#39;, &#39;team_alias&#39;, &#39;created_at&#39;)

  • :sort_order (String) —

    Sort order (&#39;asc&#39; or &#39;desc&#39;) (default to ‘asc’)

Returns:

  • (Array<(TeamListResponse, Integer, Hash)>) —

    TeamListResponse data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/litellm_client/api/team_management_api.rb', line 537

def list_team_v2_v2_team_list_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.list_team_v2_v2_team_list_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TeamManagementApi.list_team_v2_v2_team_list_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TeamManagementApi.list_team_v2_v2_team_list_get, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TeamManagementApi.list_team_v2_v2_team_list_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/team/list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'organization_id'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?
  query_params[:'team_alias'] = opts[:'team_alias'] if !opts[:'team_alias'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TeamListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.list_team_v2_v2_team_list_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#list_team_v2_v2_team_list_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#new_team_team_new_post(new_team_request, opts = {}) ⇒ LiteLLMTeamTable

New Team Allow users to create a new team. Apply user permissions to their team. 👉 [Detailed Doc on setting team budgets](docs.litellm.ai/docs/proxy/team_budgets) Parameters: - team_alias: Optional - User defined team alias - team_id: Optional - The team id of the user. If none passed, we’ll generate it. - members_with_roles: List["admin" or "user", "user_id": "<user-id>"] - A list of users and their roles in the team. Get user_id when making a new user via ‘/user/new`. - team_member_permissions: Optional[List] - A list of routes that non-admin team members can access. example: ["/key/generate", "/key/update", "/key/delete"] - metadata: Optional - Metadata for team, store information for team. Example metadata = "some info" - tpm_limit: Optional - The TPM (Tokens Per Minute) limit for this team - all keys with this team_id will have at max this TPM limit - rpm_limit: Optional - The RPM (Requests Per Minute) limit for this team - all keys associated with this team_id will have at max this RPM limit - max_budget: Optional - The maximum budget allocated to the team - all keys for this team_id will have at max this max_budget - budget_duration: Optional - The duration of the budget for the team. Doc [here](docs.litellm.ai/docs/proxy/team_budgets) - models: Optional - A list of models associated with the team - all keys for this team_id will have at most, these models. If empty, assumes all models are allowed. - blocked: bool - Flag indicating if the team is blocked or not - will stop all calls from keys with this team_id. - members: Optional - Control team members via `/team/member/add` and `/team/member/delete`. - tags: Optional[List] - Tags for [tracking spend](litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](litellm.vercel.app/docs/proxy/tag_routing). - organization_id: Optional - The organization id of the team. Default is None. Create via `/organization/new`. - model_aliases: Optional - Model aliases for the team. [Docs](docs.litellm.ai/docs/proxy/team_based_routing#create-team-with-model-alias) - guardrails: Optional[List] - Guardrails for the team. [Docs](docs.litellm.ai/docs/proxy/guardrails) - object_permission: Optional - team-specific object permission. Example - ["vector_store_1", "vector_store_2"]. IF null or {} then no object permission. Returns: - team_id: (str) Unique team id - used for tracking spend across multiple keys for same team id. _deprecated_params: - admins: list - A list of user_id’s for the admin role - users: list - A list of user_id’s for the user role Example Request: “‘ curl –location ’0.0.0.0:4000/team/new’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data ‘{ "team_alias": "my-new-team_2", "members_with_roles": ["admin", "user_id": "user-1234", "user", "user_id": "user-2434"] }’ “‘ “` curl –location ’0.0.0.0:4000/team/new’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data ‘{ "team_alias": "QA Prod Bot", "max_budget": 0.000000001, "budget_duration": "1d" }’ “‘

Parameters:

  • new_team_request (NewTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:



607
608
609
610
 
# File 'lib/litellm_client/api/team_management_api.rb', line 607

def new_team_team_new_post(new_team_request, opts = {})
  data, _status_code, _headers = new_team_team_new_post_with_http_info(new_team_request, opts)
  data
end

#new_team_team_new_post_with_http_info(new_team_request, opts = {}) ⇒ Array<(LiteLLMTeamTable, Integer, Hash)>

New Team Allow users to create a new team. Apply user permissions to their team. 👉 [Detailed Doc on setting team budgets](docs.litellm.ai/docs/proxy/team_budgets) Parameters: - team_alias: Optional - User defined team alias - team_id: Optional - The team id of the user. If none passed, we&#39;ll generate it. - members_with_roles: List[&quot;admin&quot; or &quot;user&quot;, &quot;user_id&quot;: &quot;&lt;user-id&gt;&quot;] - A list of users and their roles in the team. Get user_id when making a new user via &#x60;/user/new&#x60;. - team_member_permissions: Optional[List] - A list of routes that non-admin team members can access. example: [&quot;/key/generate&quot;, &quot;/key/update&quot;, &quot;/key/delete&quot;] - metadata: Optional - Metadata for team, store information for team. Example metadata &#x3D; &quot;some info&quot; - tpm_limit: Optional - The TPM (Tokens Per Minute) limit for this team - all keys with this team_id will have at max this TPM limit - rpm_limit: Optional - The RPM (Requests Per Minute) limit for this team - all keys associated with this team_id will have at max this RPM limit - max_budget: Optional - The maximum budget allocated to the team - all keys for this team_id will have at max this max_budget - budget_duration: Optional - The duration of the budget for the team. Doc [here](docs.litellm.ai/docs/proxy/team_budgets) - models: Optional - A list of models associated with the team - all keys for this team_id will have at most, these models. If empty, assumes all models are allowed. - blocked: bool - Flag indicating if the team is blocked or not - will stop all calls from keys with this team_id. - members: Optional - Control team members via &#x60;/team/member/add&#x60; and &#x60;/team/member/delete&#x60;. - tags: Optional[List] - Tags for [tracking spend](litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](litellm.vercel.app/docs/proxy/tag_routing). - organization_id: Optional - The organization id of the team. Default is None. Create via &#x60;/organization/new&#x60;. - model_aliases: Optional - Model aliases for the team. [Docs](docs.litellm.ai/docs/proxy/team_based_routing#create-team-with-model-alias) - guardrails: Optional[List] - Guardrails for the team. [Docs](docs.litellm.ai/docs/proxy/guardrails) - object_permission: Optional - team-specific object permission. Example - [&quot;vector_store_1&quot;, &quot;vector_store_2&quot;]. IF null or {} then no object permission. Returns: - team_id: (str) Unique team id - used for tracking spend across multiple keys for same team id. _deprecated_params: - admins: list - A list of user_id&#39;s for the admin role - users: list - A list of user_id&#39;s for the user role Example Request: &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/new&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data &#39;{ &quot;team_alias&quot;: &quot;my-new-team_2&quot;, &quot;members_with_roles&quot;: [&quot;admin&quot;, &quot;user_id&quot;: &quot;user-1234&quot;, &quot;user&quot;, &quot;user_id&quot;: &quot;user-2434&quot;] }&#39; &#x60;&#x60;&#x60; &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/new&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data &#39;{ &quot;team_alias&quot;: &quot;QA Prod Bot&quot;, &quot;max_budget&quot;: 0.000000001, &quot;budget_duration&quot;: &quot;1d&quot; }&#39; &#x60;&#x60;&#x60;

Parameters:

  • new_team_request (NewTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:

  • (Array<(LiteLLMTeamTable, Integer, Hash)>) —

    LiteLLMTeamTable data, response status code and response headers



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/litellm_client/api/team_management_api.rb', line 618

def new_team_team_new_post_with_http_info(new_team_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.new_team_team_new_post ...'
  end
  # verify the required parameter 'new_team_request' is set
  if @api_client.config.client_side_validation && new_team_request.nil?
    fail ArgumentError, "Missing the required parameter 'new_team_request' when calling TeamManagementApi.new_team_team_new_post"
  end
  # resource path
  local_var_path = '/team/new'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'litellm-changed-by'] = opts[:'litellm_changed_by'] if !opts[:'litellm_changed_by'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(new_team_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LiteLLMTeamTable'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.new_team_team_new_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#new_team_team_new_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_info_team_info_get(opts = {}) ⇒ Object

Team Info get info on team + related keys Parameters: - team_id: str - Required. The unique identifier of the team to get info on. “‘ curl –location ’localhost:4000/team/info?team_id=your_team_id_here’ –header ‘Authorization: Bearer your_api_key_here’ “‘

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_id (String) —

    Team ID in the request parameters

Returns:

  • (Object) 


677
678
679
680
 
# File 'lib/litellm_client/api/team_management_api.rb', line 677

def team_info_team_info_get(opts = {})
  data, _status_code, _headers = team_info_team_info_get_with_http_info(opts)
  data
end

#team_info_team_info_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Team Info get info on team + related keys Parameters: - team_id: str - Required. The unique identifier of the team to get info on. &#x60;&#x60;&#x60; curl –location &#39;localhost:4000/team/info?team_id&#x3D;your_team_id_here&#39; –header &#39;Authorization: Bearer your_api_key_here&#39; &#x60;&#x60;&#x60;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_id (String) —

    Team ID in the request parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/litellm_client/api/team_management_api.rb', line 687

def team_info_team_info_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.team_info_team_info_get ...'
  end
  # resource path
  local_var_path = '/team/info'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.team_info_team_info_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#team_info_team_info_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_member_add_team_member_add_post(team_member_add_request, opts = {}) ⇒ TeamAddMemberResponse

Team Member Add

BETA

Add new members (either via user_email or user_id) to a team If user doesn’t exist, new user row will also be added to User Table Only proxy_admin or admin of team, allowed to access this endpoint. “‘ curl -X POST ’0.0.0.0:4000/team/member_add’ -H ‘Authorization: Bearer sk-1234’ -H ‘Content-Type: application/json’ -d ‘"45e3e396-ee08-4a61-a88e-16b3ce7e0849", "member": {"role": "user", "user_id": "[email protected]"}’ “‘

Parameters:

  • team_member_add_request (TeamMemberAddRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



737
738
739
740
 
# File 'lib/litellm_client/api/team_management_api.rb', line 737

def team_member_add_team_member_add_post(team_member_add_request, opts = {})
  data, _status_code, _headers = team_member_add_team_member_add_post_with_http_info(team_member_add_request, opts)
  data
end

#team_member_add_team_member_add_post_with_http_info(team_member_add_request, opts = {}) ⇒ Array<(TeamAddMemberResponse, Integer, Hash)>

Team Member Add

BETA

Add new members (either via user_email or user_id) to a team If user doesn&#39;t exist, new user row will also be added to User Table Only proxy_admin or admin of team, allowed to access this endpoint. &#x60;&#x60;&#x60; curl -X POST &#39;0.0.0.0:4000/team/member_add&#39; -H &#39;Authorization: Bearer sk-1234&#39; -H &#39;Content-Type: application/json&#39; -d &#39;&quot;45e3e396-ee08-4a61-a88e-16b3ce7e0849&quot;, &quot;member&quot;: {&quot;role&quot;: &quot;user&quot;, &quot;user_id&quot;: &quot;[email protected]&quot;}&#39; &#x60;&#x60;&#x60;

Parameters:

  • team_member_add_request (TeamMemberAddRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TeamAddMemberResponse, Integer, Hash)>) —

    TeamAddMemberResponse data, response status code and response headers



747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/litellm_client/api/team_management_api.rb', line 747

def team_member_add_team_member_add_post_with_http_info(team_member_add_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.team_member_add_team_member_add_post ...'
  end
  # verify the required parameter 'team_member_add_request' is set
  if @api_client.config.client_side_validation && team_member_add_request.nil?
    fail ArgumentError, "Missing the required parameter 'team_member_add_request' when calling TeamManagementApi.team_member_add_team_member_add_post"
  end
  # resource path
  local_var_path = '/team/member_add'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(team_member_add_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TeamAddMemberResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.team_member_add_team_member_add_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#team_member_add_team_member_add_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_member_delete_team_member_delete_post(team_member_delete_request, opts = {}) ⇒ Object

Team Member Delete

BETA

delete members (either via user_email or user_id) from a team If user doesn’t exist, an exception will be raised “‘ curl -X POST ’0.0.0.0:8000/team/member_delete’ -H ‘Authorization: Bearer sk-1234’ -H ‘Content-Type: application/json’ -d ‘{ "team_id": "45e3e396-ee08-4a61-a88e-16b3ce7e0849", "user_id": "[email protected]" }’ “‘

Parameters:

Returns:

  • (Object) 


805
806
807
808
 
# File 'lib/litellm_client/api/team_management_api.rb', line 805

def team_member_delete_team_member_delete_post(team_member_delete_request, opts = {})
  data, _status_code, _headers = team_member_delete_team_member_delete_post_with_http_info(team_member_delete_request, opts)
  data
end

#team_member_delete_team_member_delete_post_with_http_info(team_member_delete_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Team Member Delete

BETA

delete members (either via user_email or user_id) from a team If user doesn&#39;t exist, an exception will be raised &#x60;&#x60;&#x60; curl -X POST &#39;0.0.0.0:8000/team/member_delete&#39; -H &#39;Authorization: Bearer sk-1234&#39; -H &#39;Content-Type: application/json&#39; -d &#39;{ &quot;team_id&quot;: &quot;45e3e396-ee08-4a61-a88e-16b3ce7e0849&quot;, &quot;user_id&quot;: &quot;[email protected]&quot; }&#39; &#x60;&#x60;&#x60;

Parameters:

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/litellm_client/api/team_management_api.rb', line 815

def team_member_delete_team_member_delete_post_with_http_info(team_member_delete_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.team_member_delete_team_member_delete_post ...'
  end
  # verify the required parameter 'team_member_delete_request' is set
  if @api_client.config.client_side_validation && team_member_delete_request.nil?
    fail ArgumentError, "Missing the required parameter 'team_member_delete_request' when calling TeamManagementApi.team_member_delete_team_member_delete_post"
  end
  # resource path
  local_var_path = '/team/member_delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(team_member_delete_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.team_member_delete_team_member_delete_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#team_member_delete_team_member_delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_member_permissions_team_permissions_list_get(opts = {}) ⇒ GetTeamMemberPermissionsResponse

Team Member Permissions Get the team member permissions for a team

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_id (String) —

    Team ID in the request parameters

Returns:



873
874
875
876
 
# File 'lib/litellm_client/api/team_management_api.rb', line 873

def team_member_permissions_team_permissions_list_get(opts = {})
  data, _status_code, _headers = team_member_permissions_team_permissions_list_get_with_http_info(opts)
  data
end

#team_member_permissions_team_permissions_list_get_with_http_info(opts = {}) ⇒ Array<(GetTeamMemberPermissionsResponse, Integer, Hash)>

Team Member Permissions Get the team member permissions for a team

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :team_id (String) —

    Team ID in the request parameters

Returns:



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/litellm_client/api/team_management_api.rb', line 883

def team_member_permissions_team_permissions_list_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.team_member_permissions_team_permissions_list_get ...'
  end
  # resource path
  local_var_path = '/team/permissions_list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetTeamMemberPermissionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.team_member_permissions_team_permissions_list_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#team_member_permissions_team_permissions_list_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_member_update_team_member_update_post(team_member_update_request, opts = {}) ⇒ TeamMemberUpdateResponse

Team Member Update

BETA

Update team member budgets and team member role

Parameters:

Returns:



933
934
935
936
 
# File 'lib/litellm_client/api/team_management_api.rb', line 933

def team_member_update_team_member_update_post(team_member_update_request, opts = {})
  data, _status_code, _headers = team_member_update_team_member_update_post_with_http_info(team_member_update_request, opts)
  data
end

#team_member_update_team_member_update_post_with_http_info(team_member_update_request, opts = {}) ⇒ Array<(TeamMemberUpdateResponse, Integer, Hash)>

Team Member Update

BETA

Update team member budgets and team member role

Parameters:

Returns:

  • (Array<(TeamMemberUpdateResponse, Integer, Hash)>) —

    TeamMemberUpdateResponse data, response status code and response headers



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/litellm_client/api/team_management_api.rb', line 943

def team_member_update_team_member_update_post_with_http_info(team_member_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.team_member_update_team_member_update_post ...'
  end
  # verify the required parameter 'team_member_update_request' is set
  if @api_client.config.client_side_validation && team_member_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'team_member_update_request' when calling TeamManagementApi.team_member_update_team_member_update_post"
  end
  # resource path
  local_var_path = '/team/member_update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(team_member_update_request)

  # return_type
  return_type = opts[:debug_return_type] || 'TeamMemberUpdateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.team_member_update_team_member_update_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#team_member_update_team_member_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_model_add_team_model_add_post(team_model_add_request, opts = {}) ⇒ Object

Team Model Add Add models to a team’s allowed model list. Only proxy admin or team admin can add models. Parameters: - team_id: str - Required. The team to add models to - models: List - Required. List of models to add to the team Example Request: “‘ curl –location ’0.0.0.0:4000/team/model/add’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data ‘{ "team_id": "team-1234", "models": ["gpt-4", "claude-2"] }’ “‘

Parameters:

  • team_model_add_request (TeamModelAddRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1001
1002
1003
1004
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1001

def team_model_add_team_model_add_post(team_model_add_request, opts = {})
  data, _status_code, _headers = team_model_add_team_model_add_post_with_http_info(team_model_add_request, opts)
  data
end

#team_model_add_team_model_add_post_with_http_info(team_model_add_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Team Model Add Add models to a team&#39;s allowed model list. Only proxy admin or team admin can add models. Parameters: - team_id: str - Required. The team to add models to - models: List - Required. List of models to add to the team Example Request: &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/model/add&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data &#39;{ &quot;team_id&quot;: &quot;team-1234&quot;, &quot;models&quot;: [&quot;gpt-4&quot;, &quot;claude-2&quot;] }&#39; &#x60;&#x60;&#x60;

Parameters:

  • team_model_add_request (TeamModelAddRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1011

def team_model_add_team_model_add_post_with_http_info(team_model_add_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.team_model_add_team_model_add_post ...'
  end
  # verify the required parameter 'team_model_add_request' is set
  if @api_client.config.client_side_validation && team_model_add_request.nil?
    fail ArgumentError, "Missing the required parameter 'team_model_add_request' when calling TeamManagementApi.team_model_add_team_model_add_post"
  end
  # resource path
  local_var_path = '/team/model/add'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(team_model_add_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.team_model_add_team_model_add_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#team_model_add_team_model_add_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#team_model_delete_team_model_delete_post(team_model_delete_request, opts = {}) ⇒ Object

Team Model Delete Remove models from a team’s allowed model list. Only proxy admin or team admin can remove models. Parameters: - team_id: str - Required. The team to remove models from - models: List - Required. List of models to remove from the team Example Request: “‘ curl –location ’0.0.0.0:4000/team/model/delete’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data ‘{ "team_id": "team-1234", "models": ["gpt-4"] }’ “‘

Parameters:

  • team_model_delete_request (TeamModelDeleteRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1069
1070
1071
1072
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1069

def team_model_delete_team_model_delete_post(team_model_delete_request, opts = {})
  data, _status_code, _headers = team_model_delete_team_model_delete_post_with_http_info(team_model_delete_request, opts)
  data
end

#team_model_delete_team_model_delete_post_with_http_info(team_model_delete_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Team Model Delete Remove models from a team&#39;s allowed model list. Only proxy admin or team admin can remove models. Parameters: - team_id: str - Required. The team to remove models from - models: List - Required. List of models to remove from the team Example Request: &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/model/delete&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data &#39;{ &quot;team_id&quot;: &quot;team-1234&quot;, &quot;models&quot;: [&quot;gpt-4&quot;] }&#39; &#x60;&#x60;&#x60;

Parameters:

  • team_model_delete_request (TeamModelDeleteRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1079

def team_model_delete_team_model_delete_post_with_http_info(team_model_delete_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.team_model_delete_team_model_delete_post ...'
  end
  # verify the required parameter 'team_model_delete_request' is set
  if @api_client.config.client_side_validation && team_model_delete_request.nil?
    fail ArgumentError, "Missing the required parameter 'team_model_delete_request' when calling TeamManagementApi.team_model_delete_team_model_delete_post"
  end
  # resource path
  local_var_path = '/team/model/delete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(team_model_delete_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.team_model_delete_team_model_delete_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#team_model_delete_team_model_delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unblock_team_team_unblock_post(block_team_request, opts = {}) ⇒ Object

Unblock Team Blocks all calls from keys with this team id. Parameters: - team_id: str - Required. The unique identifier of the team to unblock. Example: “‘ curl –location ’0.0.0.0:4000/team/unblock’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data ‘{ "team_id": "team-1234" }’ “‘

Parameters:

  • block_team_request (BlockTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1137
1138
1139
1140
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1137

def unblock_team_team_unblock_post(block_team_request, opts = {})
  data, _status_code, _headers = unblock_team_team_unblock_post_with_http_info(block_team_request, opts)
  data
end

#unblock_team_team_unblock_post_with_http_info(block_team_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Unblock Team Blocks all calls from keys with this team id. Parameters: - team_id: str - Required. The unique identifier of the team to unblock. Example: &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/unblock&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data &#39;{ &quot;team_id&quot;: &quot;team-1234&quot; }&#39; &#x60;&#x60;&#x60;

Parameters:

  • block_team_request (BlockTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1147

def unblock_team_team_unblock_post_with_http_info(block_team_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.unblock_team_team_unblock_post ...'
  end
  # verify the required parameter 'block_team_request' is set
  if @api_client.config.client_side_validation && block_team_request.nil?
    fail ArgumentError, "Missing the required parameter 'block_team_request' when calling TeamManagementApi.unblock_team_team_unblock_post"
  end
  # resource path
  local_var_path = '/team/unblock'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(block_team_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.unblock_team_team_unblock_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#unblock_team_team_unblock_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_team_member_permissions_team_permissions_update_post(update_team_member_permissions_request, opts = {}) ⇒ LiteLLMTeamTable

Update Team Member Permissions Update the team member permissions for a team

Parameters:

Returns:



1205
1206
1207
1208
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1205

def update_team_member_permissions_team_permissions_update_post(update_team_member_permissions_request, opts = {})
  data, _status_code, _headers = update_team_member_permissions_team_permissions_update_post_with_http_info(update_team_member_permissions_request, opts)
  data
end

#update_team_member_permissions_team_permissions_update_post_with_http_info(update_team_member_permissions_request, opts = {}) ⇒ Array<(LiteLLMTeamTable, Integer, Hash)>

Update Team Member Permissions Update the team member permissions for a team

Parameters:

Returns:

  • (Array<(LiteLLMTeamTable, Integer, Hash)>) —

    LiteLLMTeamTable data, response status code and response headers



1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1215

def update_team_member_permissions_team_permissions_update_post_with_http_info(update_team_member_permissions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.update_team_member_permissions_team_permissions_update_post ...'
  end
  # verify the required parameter 'update_team_member_permissions_request' is set
  if @api_client.config.client_side_validation && update_team_member_permissions_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_team_member_permissions_request' when calling TeamManagementApi.update_team_member_permissions_team_permissions_update_post"
  end
  # resource path
  local_var_path = '/team/permissions_update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_team_member_permissions_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LiteLLMTeamTable'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.update_team_member_permissions_team_permissions_update_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#update_team_member_permissions_team_permissions_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_team_team_update_post(update_team_request, opts = {}) ⇒ Object

Update Team Use ‘/team/member_add` AND `/team/member/delete` to add/remove new team members You can now update team budget / rate limits via /team/update Parameters: - team_id: str - The team id of the user. Required param. - team_alias: Optional - User defined team alias - team_member_permissions: Optional[List] - A list of routes that non-admin team members can access. example: ["/key/generate", "/key/update", "/key/delete"] - metadata: Optional - Metadata for team, store information for team. Example metadata = {"team": "core-infra", "app": "app2", "email": "[email protected]" } - tpm_limit: Optional - The TPM (Tokens Per Minute) limit for this team - all keys with this team_id will have at max this TPM limit - rpm_limit: Optional - The RPM (Requests Per Minute) limit for this team - all keys associated with this team_id will have at max this RPM limit - max_budget: Optional - The maximum budget allocated to the team - all keys for this team_id will have at max this max_budget - budget_duration: Optional - The duration of the budget for the team. Doc [here](docs.litellm.ai/docs/proxy/team_budgets) - models: Optional - A list of models associated with the team - all keys for this team_id will have at most, these models. If empty, assumes all models are allowed. - blocked: bool - Flag indicating if the team is blocked or not - will stop all calls from keys with this team_id. - tags: Optional[List] - Tags for [tracking spend](litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](litellm.vercel.app/docs/proxy/tag_routing). - organization_id: Optional - The organization id of the team. Default is None. Create via `/organization/new`. - model_aliases: Optional - Model aliases for the team. [Docs](docs.litellm.ai/docs/proxy/team_based_routing#create-team-with-model-alias) - guardrails: Optional[List] - Guardrails for the team. [Docs](docs.litellm.ai/docs/proxy/guardrails) - object_permission: Optional - team-specific object permission. Example - ["vector_store_1", "vector_store_2"]. IF null or {} then no object permission. Example - update team TPM Limit “` curl –location ’0.0.0.0:4000/team/update’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data-raw ‘{ "team_id": "8d916b1c-510d-4894-a334-1c16a93344f5", "tpm_limit": 100 }’ “‘ Example - Update Team `max_budget` budget “` curl –location ’0.0.0.0:4000/team/update’ –header ‘Authorization: Bearer sk-1234’ –header ‘Content-Type: application/json’ –data-raw ‘{ "team_id": "8d916b1c-510d-4894-a334-1c16a93344f5", "max_budget": 10 }’ “‘

Parameters:

  • update_team_request (UpdateTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:

  • (Object) 


1274
1275
1276
1277
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1274

def update_team_team_update_post(update_team_request, opts = {})
  data, _status_code, _headers = update_team_team_update_post_with_http_info(update_team_request, opts)
  data
end

#update_team_team_update_post_with_http_info(update_team_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update Team Use &#x60;/team/member_add&#x60; AND &#x60;/team/member/delete&#x60; to add/remove new team members You can now update team budget / rate limits via /team/update Parameters: - team_id: str - The team id of the user. Required param. - team_alias: Optional - User defined team alias - team_member_permissions: Optional[List] - A list of routes that non-admin team members can access. example: [&quot;/key/generate&quot;, &quot;/key/update&quot;, &quot;/key/delete&quot;] - metadata: Optional - Metadata for team, store information for team. Example metadata &#x3D; {&quot;team&quot;: &quot;core-infra&quot;, &quot;app&quot;: &quot;app2&quot;, &quot;email&quot;: &quot;[email protected]&quot; } - tpm_limit: Optional - The TPM (Tokens Per Minute) limit for this team - all keys with this team_id will have at max this TPM limit - rpm_limit: Optional - The RPM (Requests Per Minute) limit for this team - all keys associated with this team_id will have at max this RPM limit - max_budget: Optional - The maximum budget allocated to the team - all keys for this team_id will have at max this max_budget - budget_duration: Optional - The duration of the budget for the team. Doc [here](docs.litellm.ai/docs/proxy/team_budgets) - models: Optional - A list of models associated with the team - all keys for this team_id will have at most, these models. If empty, assumes all models are allowed. - blocked: bool - Flag indicating if the team is blocked or not - will stop all calls from keys with this team_id. - tags: Optional[List] - Tags for [tracking spend](litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](litellm.vercel.app/docs/proxy/tag_routing). - organization_id: Optional - The organization id of the team. Default is None. Create via &#x60;/organization/new&#x60;. - model_aliases: Optional - Model aliases for the team. [Docs](docs.litellm.ai/docs/proxy/team_based_routing#create-team-with-model-alias) - guardrails: Optional[List] - Guardrails for the team. [Docs](docs.litellm.ai/docs/proxy/guardrails) - object_permission: Optional - team-specific object permission. Example - [&quot;vector_store_1&quot;, &quot;vector_store_2&quot;]. IF null or {} then no object permission. Example - update team TPM Limit &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/update&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data-raw &#39;{ &quot;team_id&quot;: &quot;8d916b1c-510d-4894-a334-1c16a93344f5&quot;, &quot;tpm_limit&quot;: 100 }&#39; &#x60;&#x60;&#x60; Example - Update Team &#x60;max_budget&#x60; budget &#x60;&#x60;&#x60; curl –location &#39;0.0.0.0:4000/team/update&#39; –header &#39;Authorization: Bearer sk-1234&#39; –header &#39;Content-Type: application/json&#39; –data-raw &#39;{ &quot;team_id&quot;: &quot;8d916b1c-510d-4894-a334-1c16a93344f5&quot;, &quot;max_budget&quot;: 10 }&#39; &#x60;&#x60;&#x60;

Parameters:

  • update_team_request (UpdateTeamRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :litellm_changed_by (String) —

    The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/litellm_client/api/team_management_api.rb', line 1285

def update_team_team_update_post_with_http_info(update_team_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamManagementApi.update_team_team_update_post ...'
  end
  # verify the required parameter 'update_team_request' is set
  if @api_client.config.client_side_validation && update_team_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_team_request' when calling TeamManagementApi.update_team_team_update_post"
  end
  # resource path
  local_var_path = '/team/update'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'litellm-changed-by'] = opts[:'litellm_changed_by'] if !opts[:'litellm_changed_by'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_team_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"TeamManagementApi.update_team_team_update_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamManagementApi#update_team_team_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end