@rightbrain/brain-api-client 0.0.1-dev.7.9b33e6e → 0.0.1-dev.71.d8fcdb7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.ts CHANGED
@@ -933,12 +933,6 @@ export interface ConversationalGuardrails {
933
933
  */
934
934
  'output'?: Array<OutputConversationalGuardrailDefinition>;
935
935
  }
936
- /**
937
- * @type CreateTaskForwarderRequest
938
- * @export
939
- */
940
- export type CreateTaskForwarderRequest = EmailForwarderCreate | WebhookForwarderCreate;
941
-
942
936
  /**
943
937
  * Represents a trend report for organization creation.
944
938
  * @export
@@ -3492,6 +3486,12 @@ export interface OAuthClient {
3492
3486
  * @memberof OAuthClient
3493
3487
  */
3494
3488
  'modified': string;
3489
+ /**
3490
+ * Timestamp when the OAuth client was deleted, if applicable.
3491
+ * @type {string}
3492
+ * @memberof OAuthClient
3493
+ */
3494
+ 'deleted'?: string | null;
3495
3495
  }
3496
3496
 
3497
3497
  export const OAuthClientTokenEndpointAuthMethodEnum = {
@@ -5006,6 +5006,12 @@ export interface Project {
5006
5006
  * @memberof Project
5007
5007
  */
5008
5008
  'agent_access_key'?: string | null;
5009
+ /**
5010
+ *
5011
+ * @type {string}
5012
+ * @memberof Project
5013
+ */
5014
+ 'deleted'?: string | null;
5009
5015
  }
5010
5016
  /**
5011
5017
  *
@@ -5179,6 +5185,12 @@ export interface ProjectWithDatasources {
5179
5185
  * @memberof ProjectWithDatasources
5180
5186
  */
5181
5187
  'agent_access_key'?: string | null;
5188
+ /**
5189
+ *
5190
+ * @type {string}
5191
+ * @memberof ProjectWithDatasources
5192
+ */
5193
+ 'deleted'?: string | null;
5182
5194
  /**
5183
5195
  *
5184
5196
  * @type {Array<DatasourceConnectionPublic>}
@@ -5498,6 +5510,12 @@ export type Response403Deleteorganizationdomain = { reason: 'MISSING_AUTHENTICAT
5498
5510
  */
5499
5511
  export type Response403Deleteorganizationinvite = { reason: 'MISSING_AUTHENTICATION' } & MissingAuthenticationErrorResponse | { reason: 'PERMISSION_CHECK_FAILED' } & PermissionCheckFailedErrorResponse;
5500
5512
 
5513
+ /**
5514
+ * @type Response403Deleteproject
5515
+ * @export
5516
+ */
5517
+ export type Response403Deleteproject = { reason: 'MISSING_AUTHENTICATION' } & MissingAuthenticationErrorResponse | { reason: 'PERMISSION_CHECK_FAILED' } & PermissionCheckFailedErrorResponse;
5518
+
5501
5519
  /**
5502
5520
  * @type Response403Deleteprojectdocument
5503
5521
  * @export
@@ -5921,6 +5939,50 @@ export interface RunData {
5921
5939
  */
5922
5940
  'submitted': object;
5923
5941
  }
5942
+ /**
5943
+ *
5944
+ * @export
5945
+ * @interface RunTaskRequest
5946
+ */
5947
+ export interface RunTaskRequest {
5948
+ /**
5949
+ * Key-value pairs mapping variable names to their values. Keys must match the variable placeholders in your task\'s user_prompt.
5950
+ * @type {{ [key: string]: any; }}
5951
+ * @memberof RunTaskRequest
5952
+ */
5953
+ 'task_input': { [key: string]: any; };
5954
+ /**
5955
+ * Optional base64-encoded files to include with the task run
5956
+ * @type {Array<RunTaskRequestTaskFilesInner>}
5957
+ * @memberof RunTaskRequest
5958
+ */
5959
+ 'task_files'?: Array<RunTaskRequestTaskFilesInner>;
5960
+ /**
5961
+ * Optional reference ID for tracking this task run
5962
+ * @type {string}
5963
+ * @memberof RunTaskRequest
5964
+ */
5965
+ 'task_reference'?: string;
5966
+ }
5967
+ /**
5968
+ *
5969
+ * @export
5970
+ * @interface RunTaskRequestTaskFilesInner
5971
+ */
5972
+ export interface RunTaskRequestTaskFilesInner {
5973
+ /**
5974
+ *
5975
+ * @type {string}
5976
+ * @memberof RunTaskRequestTaskFilesInner
5977
+ */
5978
+ 'filename'?: string;
5979
+ /**
5980
+ *
5981
+ * @type {string}
5982
+ * @memberof RunTaskRequestTaskFilesInner
5983
+ */
5984
+ 'content'?: string;
5985
+ }
5924
5986
  /**
5925
5987
  *
5926
5988
  * @export
@@ -6226,6 +6288,12 @@ export interface Task {
6226
6288
  * @memberof Task
6227
6289
  */
6228
6290
  'modified'?: string | null;
6291
+ /**
6292
+ * Timestamp when the task was deleted, if applicable.
6293
+ * @type {string}
6294
+ * @memberof Task
6295
+ */
6296
+ 'deleted'?: string | null;
6229
6297
  /**
6230
6298
  * Each update to a Task results in a new Revision being created. Task Revisions are a powerful concept that can be used to assist with A/B testing, comparing responses from different LLM\'s, etc.
6231
6299
  * @type {Array<TaskRevision>}
@@ -6427,6 +6495,18 @@ export const TaskCreateTaskRunVisibilityEnum = {
6427
6495
 
6428
6496
  export type TaskCreateTaskRunVisibilityEnum = typeof TaskCreateTaskRunVisibilityEnum[keyof typeof TaskCreateTaskRunVisibilityEnum];
6429
6497
 
6498
+ /**
6499
+ * @type TaskForwarder
6500
+ * @export
6501
+ */
6502
+ export type TaskForwarder = EmailForwarderCreate | WebhookForwarderCreate;
6503
+
6504
+ /**
6505
+ * @type TaskForwarder1
6506
+ * @export
6507
+ */
6508
+ export type TaskForwarder1 = EmailForwarderUpdate | WebhookForwarderUpdate;
6509
+
6430
6510
  /**
6431
6511
  *
6432
6512
  * @export
@@ -6959,6 +7039,12 @@ export interface TaskRun {
6959
7039
  * @memberof TaskRun
6960
7040
  */
6961
7041
  'reference'?: string | null;
7042
+ /**
7043
+ * An optional context ID for grouping related task runs
7044
+ * @type {string}
7045
+ * @memberof TaskRun
7046
+ */
7047
+ 'context_id'?: string | null;
6962
7048
  /**
6963
7049
  * The unique identifier of the Task Run.
6964
7050
  * @type {string}
@@ -7683,12 +7769,6 @@ export interface UpdateExpiredTrialsResponse {
7683
7769
  */
7684
7770
  export type UpdateOrgAvatar403Response = MissingAuthenticationErrorResponse | PermissionCheckFailedErrorResponse;
7685
7771
 
7686
- /**
7687
- * @type UpdateTaskForwarderRequest
7688
- * @export
7689
- */
7690
- export type UpdateTaskForwarderRequest = EmailForwarderUpdate | WebhookForwarderUpdate;
7691
-
7692
7772
  /**
7693
7773
  *
7694
7774
  * @export
@@ -8191,7 +8271,7 @@ export const APIKeysApiAxiosParamCreator = function (configuration?: Configurati
8191
8271
  };
8192
8272
  },
8193
8273
  /**
8194
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8274
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8195
8275
  * @summary List API Keys
8196
8276
  * @param {string} orgId The unique identifier of the organization.
8197
8277
  * @param {string} projectId The unique identifier of the project.
@@ -8233,7 +8313,7 @@ export const APIKeysApiAxiosParamCreator = function (configuration?: Configurati
8233
8313
  };
8234
8314
  },
8235
8315
  /**
8236
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8316
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8237
8317
  * @summary List API Keys
8238
8318
  * @param {string} orgId The unique identifier of the organization.
8239
8319
  * @param {string} projectId The unique identifier of the project.
@@ -8407,7 +8487,7 @@ export const APIKeysApiFp = function(configuration?: Configuration) {
8407
8487
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8408
8488
  },
8409
8489
  /**
8410
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8490
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8411
8491
  * @summary List API Keys
8412
8492
  * @param {string} orgId The unique identifier of the organization.
8413
8493
  * @param {string} projectId The unique identifier of the project.
@@ -8421,7 +8501,7 @@ export const APIKeysApiFp = function(configuration?: Configuration) {
8421
8501
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8422
8502
  },
8423
8503
  /**
8424
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8504
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8425
8505
  * @summary List API Keys
8426
8506
  * @param {string} orgId The unique identifier of the organization.
8427
8507
  * @param {string} projectId The unique identifier of the project.
@@ -8499,7 +8579,7 @@ export const APIKeysApiFactory = function (configuration?: Configuration, basePa
8499
8579
  return localVarFp.createApiKey_1(orgId, projectId, apiKeyCreate, options).then((request) => request(axios, basePath));
8500
8580
  },
8501
8581
  /**
8502
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8582
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8503
8583
  * @summary List API Keys
8504
8584
  * @param {string} orgId The unique identifier of the organization.
8505
8585
  * @param {string} projectId The unique identifier of the project.
@@ -8510,7 +8590,7 @@ export const APIKeysApiFactory = function (configuration?: Configuration, basePa
8510
8590
  return localVarFp.listApiKeys(orgId, projectId, options).then((request) => request(axios, basePath));
8511
8591
  },
8512
8592
  /**
8513
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8593
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8514
8594
  * @summary List API Keys
8515
8595
  * @param {string} orgId The unique identifier of the organization.
8516
8596
  * @param {string} projectId The unique identifier of the project.
@@ -8583,7 +8663,7 @@ export class APIKeysApi extends BaseAPI {
8583
8663
  }
8584
8664
 
8585
8665
  /**
8586
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8666
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8587
8667
  * @summary List API Keys
8588
8668
  * @param {string} orgId The unique identifier of the organization.
8589
8669
  * @param {string} projectId The unique identifier of the project.
@@ -8596,7 +8676,7 @@ export class APIKeysApi extends BaseAPI {
8596
8676
  }
8597
8677
 
8598
8678
  /**
8599
- * List all active API keys for the current user in the specified project. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Note**: The actual key values are not included in the response for security reasons.
8679
+ * List all active API keys for the current user in the specified project. **Note**: This endpoint returns a plain array of API keys, not a paginated response. All API keys for the user are returned in a single request. Returns all non-revoked API keys created by the authenticated user for the project. Keys are returned in descending order by creation date. **Response Fields:** - `id`: Unique identifier for the API key - `name`: Human-readable name for the key - `key`: The API key value (masked after creation for security) - `oauth_client_id`: The OAuth client this API key is associated with, if any - `last_used`: Timestamp of when the key was last used for authentication - `created_at`: When the key was created **Note**: The actual key values are not included in the response for security reasons.
8600
8680
  * @summary List API Keys
8601
8681
  * @param {string} orgId The unique identifier of the organization.
8602
8682
  * @param {string} projectId The unique identifier of the project.
@@ -14005,8 +14085,8 @@ export type DocumentIamOrgOrgIdProjectProjectIdDocumentDocumentIdIamListMembersT
14005
14085
  export const InputProcessorsApiAxiosParamCreator = function (configuration?: Configuration) {
14006
14086
  return {
14007
14087
  /**
14008
- * Returns a list of all available input processors that can be used to transform task inputs. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14009
- * @summary List available Input Processors
14088
+ * Returns a list of all available input processors that can be used to transform task inputs. **Note**: This endpoint returns a plain array of processors, not a paginated response. All available processors are returned in a single request. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14089
+ * @summary List Input Processors
14010
14090
  * @param {string} orgId The unique identifier of the organization.
14011
14091
  * @param {string} projectId The unique identifier of the project.
14012
14092
  * @param {*} [options] Override http request option.
@@ -14057,8 +14137,8 @@ export const InputProcessorsApiFp = function(configuration?: Configuration) {
14057
14137
  const localVarAxiosParamCreator = InputProcessorsApiAxiosParamCreator(configuration)
14058
14138
  return {
14059
14139
  /**
14060
- * Returns a list of all available input processors that can be used to transform task inputs. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14061
- * @summary List available Input Processors
14140
+ * Returns a list of all available input processors that can be used to transform task inputs. **Note**: This endpoint returns a plain array of processors, not a paginated response. All available processors are returned in a single request. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14141
+ * @summary List Input Processors
14062
14142
  * @param {string} orgId The unique identifier of the organization.
14063
14143
  * @param {string} projectId The unique identifier of the project.
14064
14144
  * @param {*} [options] Override http request option.
@@ -14081,8 +14161,8 @@ export const InputProcessorsApiFactory = function (configuration?: Configuration
14081
14161
  const localVarFp = InputProcessorsApiFp(configuration)
14082
14162
  return {
14083
14163
  /**
14084
- * Returns a list of all available input processors that can be used to transform task inputs. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14085
- * @summary List available Input Processors
14164
+ * Returns a list of all available input processors that can be used to transform task inputs. **Note**: This endpoint returns a plain array of processors, not a paginated response. All available processors are returned in a single request. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14165
+ * @summary List Input Processors
14086
14166
  * @param {string} orgId The unique identifier of the organization.
14087
14167
  * @param {string} projectId The unique identifier of the project.
14088
14168
  * @param {*} [options] Override http request option.
@@ -14102,8 +14182,8 @@ export const InputProcessorsApiFactory = function (configuration?: Configuration
14102
14182
  */
14103
14183
  export class InputProcessorsApi extends BaseAPI {
14104
14184
  /**
14105
- * Returns a list of all available input processors that can be used to transform task inputs. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14106
- * @summary List available Input Processors
14185
+ * Returns a list of all available input processors that can be used to transform task inputs. **Note**: This endpoint returns a plain array of processors, not a paginated response. All available processors are returned in a single request. Input processors are utility functions that can modify or enhance the input data before it is processed by the task. Each processor supports optional configuration parameters to customize its behavior. Available processors: - **url_fetcher**: Fetches HTML content from URLs - **perplexity_search**: Searches the web for real-time information - **document_content_extractor**: Extracts text from uploaded documents
14186
+ * @summary List Input Processors
14107
14187
  * @param {string} orgId The unique identifier of the organization.
14108
14188
  * @param {string} projectId The unique identifier of the project.
14109
14189
  * @param {*} [options] Override http request option.
@@ -16951,7 +17031,7 @@ export type RemoveModelExclusionFromProjectRuleTypeEnum = typeof RemoveModelExcl
16951
17031
  export const ListingsApiAxiosParamCreator = function (configuration?: Configuration) {
16952
17032
  return {
16953
17033
  /**
16954
- * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
17034
+ * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. **Note**: This endpoint returns a plain array of models, not a paginated response. All available models are returned in a single request. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
16955
17035
  * @summary List Available LLM Models
16956
17036
  * @param {string} orgId The unique identifier of the organization.
16957
17037
  * @param {string} projectId The unique identifier of the project.
@@ -17044,7 +17124,7 @@ export const ListingsApiAxiosParamCreator = function (configuration?: Configurat
17044
17124
  };
17045
17125
  },
17046
17126
  /**
17047
- * Retrieve a list of all available guardrails for content validation. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17127
+ * Retrieve a list of all available guardrails for content validation. **Note**: This endpoint returns a plain array of guardrails, not a paginated response. All available guardrails are returned in a single request. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17048
17128
  * @summary List Available Guardrails
17049
17129
  * @param {string} orgId The unique identifier of the organization.
17050
17130
  * @param {string} projectId The unique identifier of the project.
@@ -17092,7 +17172,7 @@ export const ListingsApiFp = function(configuration?: Configuration) {
17092
17172
  const localVarAxiosParamCreator = ListingsApiAxiosParamCreator(configuration)
17093
17173
  return {
17094
17174
  /**
17095
- * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
17175
+ * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. **Note**: This endpoint returns a plain array of models, not a paginated response. All available models are returned in a single request. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
17096
17176
  * @summary List Available LLM Models
17097
17177
  * @param {string} orgId The unique identifier of the organization.
17098
17178
  * @param {string} projectId The unique identifier of the project.
@@ -17122,7 +17202,7 @@ export const ListingsApiFp = function(configuration?: Configuration) {
17122
17202
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17123
17203
  },
17124
17204
  /**
17125
- * Retrieve a list of all available guardrails for content validation. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17205
+ * Retrieve a list of all available guardrails for content validation. **Note**: This endpoint returns a plain array of guardrails, not a paginated response. All available guardrails are returned in a single request. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17126
17206
  * @summary List Available Guardrails
17127
17207
  * @param {string} orgId The unique identifier of the organization.
17128
17208
  * @param {string} projectId The unique identifier of the project.
@@ -17146,7 +17226,7 @@ export const ListingsApiFactory = function (configuration?: Configuration, baseP
17146
17226
  const localVarFp = ListingsApiFp(configuration)
17147
17227
  return {
17148
17228
  /**
17149
- * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
17229
+ * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. **Note**: This endpoint returns a plain array of models, not a paginated response. All available models are returned in a single request. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
17150
17230
  * @summary List Available LLM Models
17151
17231
  * @param {string} orgId The unique identifier of the organization.
17152
17232
  * @param {string} projectId The unique identifier of the project.
@@ -17170,7 +17250,7 @@ export const ListingsApiFactory = function (configuration?: Configuration, baseP
17170
17250
  return localVarFp.getModel(modelIdOrName, orgId, projectId, options).then((request) => request(axios, basePath));
17171
17251
  },
17172
17252
  /**
17173
- * Retrieve a list of all available guardrails for content validation. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17253
+ * Retrieve a list of all available guardrails for content validation. **Note**: This endpoint returns a plain array of guardrails, not a paginated response. All available guardrails are returned in a single request. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17174
17254
  * @summary List Available Guardrails
17175
17255
  * @param {string} orgId The unique identifier of the organization.
17176
17256
  * @param {string} projectId The unique identifier of the project.
@@ -17191,7 +17271,7 @@ export const ListingsApiFactory = function (configuration?: Configuration, baseP
17191
17271
  */
17192
17272
  export class ListingsApi extends BaseAPI {
17193
17273
  /**
17194
- * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
17274
+ * Retrieve a list of all available Large Language Models (LLMs) that can be used in Tasks. **Note**: This endpoint returns a plain array of models, not a paginated response. All available models are returned in a single request. By default, only active models are returned. Use the `include_retired=true` query parameter to include retired models. Each model entry includes standard fields like: - Unique identifier (`id`) - Provider information (`provider`) - Vendor information (`vendor`) - Model reference name (`name`) - Human-readable alias (`alias`) - Detailed description (`description`) - Vision support status (`supports_vision`) - Whether the model can process images - Image output support (`supports_image_output`) - Whether the model can generate images - Maximum context window (`max_context_window`) - Disabled parameters (`disabled_params`) - When the model was retired (`retired`) - The model that replaces it (`replaced_by`) Models may have different capabilities, performance characteristics, and cost structures. Choose models based on your specific needs.
17195
17275
  * @summary List Available LLM Models
17196
17276
  * @param {string} orgId The unique identifier of the organization.
17197
17277
  * @param {string} projectId The unique identifier of the project.
@@ -17219,7 +17299,7 @@ export class ListingsApi extends BaseAPI {
17219
17299
  }
17220
17300
 
17221
17301
  /**
17222
- * Retrieve a list of all available guardrails for content validation. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17302
+ * Retrieve a list of all available guardrails for content validation. **Note**: This endpoint returns a plain array of guardrails, not a paginated response. All available guardrails are returned in a single request. Guardrails help ensure AI outputs are: - Safe and appropriate - Factually accurate - Compliant with policies - Free from harmful content - Properly formatted Each guardrail specializes in different validation aspects like: - Toxicity detection - PII (Personal Information) detection - Factual accuracy checking - Format validation - Custom business rules Use these guardrails in tasks to automatically validate outputs.
17223
17303
  * @summary List Available Guardrails
17224
17304
  * @param {string} orgId The unique identifier of the organization.
17225
17305
  * @param {string} projectId The unique identifier of the project.
@@ -18640,13 +18720,13 @@ export class MCPServersApi extends BaseAPI {
18640
18720
 
18641
18721
 
18642
18722
  /**
18643
- * OauthClientsApi - axios parameter creator
18723
+ * OAuthClientsApi - axios parameter creator
18644
18724
  * @export
18645
18725
  */
18646
- export const OauthClientsApiAxiosParamCreator = function (configuration?: Configuration) {
18726
+ export const OAuthClientsApiAxiosParamCreator = function (configuration?: Configuration) {
18647
18727
  return {
18648
18728
  /**
18649
- * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access Configure grant types based on your use case: - **authorization_code**: Web applications with backend - **client_credentials**: Service-to-service auth - **refresh_token**: Long-lived access - **implicit**: Single-page applications (deprecated) **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
18729
+ * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access **Choosing the Right Grant Type:** | Use Case | Grant Type | PKCE | Notes | |----------|------------|------|-------| | Web app with backend | `authorization_code` | Optional | Most secure for user-facing apps | | Mobile/Desktop app | `authorization_code` | Required | Public client, no secret storage | | Server-to-server | `client_credentials` | No | For automated services, no user context | | Single-page app | `authorization_code` | Required | Use PKCE instead of implicit | | Long-lived sessions | Add `refresh_token` | - | Combine with primary grant type | **Grant Type Details:** - **authorization_code**: User authorizes app via browser, app exchanges code for tokens - **client_credentials**: Service authenticates directly with client_id/secret (no user) - **refresh_token**: Exchange refresh token for new access token (add to other grants) - **implicit**: *Deprecated* - Use authorization_code + PKCE instead **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
18650
18730
  * @summary Create OAuth Client
18651
18731
  * @param {string} orgId The unique identifier of the organization.
18652
18732
  * @param {string} projectId The unique identifier of the project.
@@ -19154,14 +19234,14 @@ export const OauthClientsApiAxiosParamCreator = function (configuration?: Config
19154
19234
  };
19155
19235
 
19156
19236
  /**
19157
- * OauthClientsApi - functional programming interface
19237
+ * OAuthClientsApi - functional programming interface
19158
19238
  * @export
19159
19239
  */
19160
- export const OauthClientsApiFp = function(configuration?: Configuration) {
19161
- const localVarAxiosParamCreator = OauthClientsApiAxiosParamCreator(configuration)
19240
+ export const OAuthClientsApiFp = function(configuration?: Configuration) {
19241
+ const localVarAxiosParamCreator = OAuthClientsApiAxiosParamCreator(configuration)
19162
19242
  return {
19163
19243
  /**
19164
- * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access Configure grant types based on your use case: - **authorization_code**: Web applications with backend - **client_credentials**: Service-to-service auth - **refresh_token**: Long-lived access - **implicit**: Single-page applications (deprecated) **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
19244
+ * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access **Choosing the Right Grant Type:** | Use Case | Grant Type | PKCE | Notes | |----------|------------|------|-------| | Web app with backend | `authorization_code` | Optional | Most secure for user-facing apps | | Mobile/Desktop app | `authorization_code` | Required | Public client, no secret storage | | Server-to-server | `client_credentials` | No | For automated services, no user context | | Single-page app | `authorization_code` | Required | Use PKCE instead of implicit | | Long-lived sessions | Add `refresh_token` | - | Combine with primary grant type | **Grant Type Details:** - **authorization_code**: User authorizes app via browser, app exchanges code for tokens - **client_credentials**: Service authenticates directly with client_id/secret (no user) - **refresh_token**: Exchange refresh token for new access token (add to other grants) - **implicit**: *Deprecated* - Use authorization_code + PKCE instead **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
19165
19245
  * @summary Create OAuth Client
19166
19246
  * @param {string} orgId The unique identifier of the organization.
19167
19247
  * @param {string} projectId The unique identifier of the project.
@@ -19172,7 +19252,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19172
19252
  async createOAuthClient(orgId: string, projectId: string, oAuthClientCreate: OAuthClientCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuthClient>> {
19173
19253
  const localVarAxiosArgs = await localVarAxiosParamCreator.createOAuthClient(orgId, projectId, oAuthClientCreate, options);
19174
19254
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19175
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.createOAuthClient']?.[localVarOperationServerIndex]?.url;
19255
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.createOAuthClient']?.[localVarOperationServerIndex]?.url;
19176
19256
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19177
19257
  },
19178
19258
  /**
@@ -19187,7 +19267,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19187
19267
  async deleteOAuthClient(oauthClientId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
19188
19268
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOAuthClient(oauthClientId, orgId, projectId, options);
19189
19269
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19190
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.deleteOAuthClient']?.[localVarOperationServerIndex]?.url;
19270
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.deleteOAuthClient']?.[localVarOperationServerIndex]?.url;
19191
19271
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19192
19272
  },
19193
19273
  /**
@@ -19202,7 +19282,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19202
19282
  async getOAuthClient(oauthClientId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuthClient>> {
19203
19283
  const localVarAxiosArgs = await localVarAxiosParamCreator.getOAuthClient(oauthClientId, orgId, projectId, options);
19204
19284
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19205
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.getOAuthClient']?.[localVarOperationServerIndex]?.url;
19285
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.getOAuthClient']?.[localVarOperationServerIndex]?.url;
19206
19286
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19207
19287
  },
19208
19288
  /**
@@ -19218,7 +19298,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19218
19298
  async listOAuthClients(orgId: string, projectId: string, pageLimit?: number | null, cursor?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResultSetOAuthClient>> {
19219
19299
  const localVarAxiosArgs = await localVarAxiosParamCreator.listOAuthClients(orgId, projectId, pageLimit, cursor, options);
19220
19300
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19221
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.listOAuthClients']?.[localVarOperationServerIndex]?.url;
19301
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.listOAuthClients']?.[localVarOperationServerIndex]?.url;
19222
19302
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19223
19303
  },
19224
19304
  /**
@@ -19234,7 +19314,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19234
19314
  async projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId: string, member: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IAMMember>> {
19235
19315
  const localVarAxiosArgs = await localVarAxiosParamCreator.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId, member, orgId, projectId, options);
19236
19316
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19237
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember']?.[localVarOperationServerIndex]?.url;
19317
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember']?.[localVarOperationServerIndex]?.url;
19238
19318
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19239
19319
  },
19240
19320
  /**
@@ -19250,7 +19330,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19250
19330
  async projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId: string, orgId: string, projectId: string, type?: ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResultSetIAMMember>> {
19251
19331
  const localVarAxiosArgs = await localVarAxiosParamCreator.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId, orgId, projectId, type, options);
19252
19332
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19253
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers']?.[localVarOperationServerIndex]?.url;
19333
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers']?.[localVarOperationServerIndex]?.url;
19254
19334
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19255
19335
  },
19256
19336
  /**
@@ -19266,7 +19346,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19266
19346
  async projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId: string, orgId: string, projectId: string, brainApiApiV1IamProjectIAMPermissionTest: BrainApiApiV1IamProjectIAMPermissionTest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IAMPermissionTest>> {
19267
19347
  const localVarAxiosArgs = await localVarAxiosParamCreator.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId, orgId, projectId, brainApiApiV1IamProjectIAMPermissionTest, options);
19268
19348
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19269
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions']?.[localVarOperationServerIndex]?.url;
19349
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions']?.[localVarOperationServerIndex]?.url;
19270
19350
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19271
19351
  },
19272
19352
  /**
@@ -19283,7 +19363,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19283
19363
  async projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId: string, member: string, orgId: string, projectId: string, brainApiApiV1IamProjectIAMMemberRoleUpdate: BrainApiApiV1IamProjectIAMMemberRoleUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IAMMember>> {
19284
19364
  const localVarAxiosArgs = await localVarAxiosParamCreator.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId, member, orgId, projectId, brainApiApiV1IamProjectIAMMemberRoleUpdate, options);
19285
19365
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19286
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles']?.[localVarOperationServerIndex]?.url;
19366
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles']?.[localVarOperationServerIndex]?.url;
19287
19367
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19288
19368
  },
19289
19369
  /**
@@ -19299,7 +19379,7 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19299
19379
  async regenerateOAuthClientSecret(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuthClientRegenerateSecretResponse>> {
19300
19380
  const localVarAxiosArgs = await localVarAxiosParamCreator.regenerateOAuthClientSecret(oauthClientId, orgId, projectId, oAuthClientUpdate, options);
19301
19381
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19302
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.regenerateOAuthClientSecret']?.[localVarOperationServerIndex]?.url;
19382
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.regenerateOAuthClientSecret']?.[localVarOperationServerIndex]?.url;
19303
19383
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19304
19384
  },
19305
19385
  /**
@@ -19315,21 +19395,21 @@ export const OauthClientsApiFp = function(configuration?: Configuration) {
19315
19395
  async updateOAuthClient(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuthClient>> {
19316
19396
  const localVarAxiosArgs = await localVarAxiosParamCreator.updateOAuthClient(oauthClientId, orgId, projectId, oAuthClientUpdate, options);
19317
19397
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19318
- const localVarOperationServerBasePath = operationServerMap['OauthClientsApi.updateOAuthClient']?.[localVarOperationServerIndex]?.url;
19398
+ const localVarOperationServerBasePath = operationServerMap['OAuthClientsApi.updateOAuthClient']?.[localVarOperationServerIndex]?.url;
19319
19399
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19320
19400
  },
19321
19401
  }
19322
19402
  };
19323
19403
 
19324
19404
  /**
19325
- * OauthClientsApi - factory interface
19405
+ * OAuthClientsApi - factory interface
19326
19406
  * @export
19327
19407
  */
19328
- export const OauthClientsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
19329
- const localVarFp = OauthClientsApiFp(configuration)
19408
+ export const OAuthClientsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
19409
+ const localVarFp = OAuthClientsApiFp(configuration)
19330
19410
  return {
19331
19411
  /**
19332
- * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access Configure grant types based on your use case: - **authorization_code**: Web applications with backend - **client_credentials**: Service-to-service auth - **refresh_token**: Long-lived access - **implicit**: Single-page applications (deprecated) **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
19412
+ * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access **Choosing the Right Grant Type:** | Use Case | Grant Type | PKCE | Notes | |----------|------------|------|-------| | Web app with backend | `authorization_code` | Optional | Most secure for user-facing apps | | Mobile/Desktop app | `authorization_code` | Required | Public client, no secret storage | | Server-to-server | `client_credentials` | No | For automated services, no user context | | Single-page app | `authorization_code` | Required | Use PKCE instead of implicit | | Long-lived sessions | Add `refresh_token` | - | Combine with primary grant type | **Grant Type Details:** - **authorization_code**: User authorizes app via browser, app exchanges code for tokens - **client_credentials**: Service authenticates directly with client_id/secret (no user) - **refresh_token**: Exchange refresh token for new access token (add to other grants) - **implicit**: *Deprecated* - Use authorization_code + PKCE instead **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
19333
19413
  * @summary Create OAuth Client
19334
19414
  * @param {string} orgId The unique identifier of the organization.
19335
19415
  * @param {string} projectId The unique identifier of the project.
@@ -19460,24 +19540,24 @@ export const OauthClientsApiFactory = function (configuration?: Configuration, b
19460
19540
  };
19461
19541
 
19462
19542
  /**
19463
- * OauthClientsApi - object-oriented interface
19543
+ * OAuthClientsApi - object-oriented interface
19464
19544
  * @export
19465
- * @class OauthClientsApi
19545
+ * @class OAuthClientsApi
19466
19546
  * @extends {BaseAPI}
19467
19547
  */
19468
- export class OauthClientsApi extends BaseAPI {
19548
+ export class OAuthClientsApi extends BaseAPI {
19469
19549
  /**
19470
- * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access Configure grant types based on your use case: - **authorization_code**: Web applications with backend - **client_credentials**: Service-to-service auth - **refresh_token**: Long-lived access - **implicit**: Single-page applications (deprecated) **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
19550
+ * Create a new OAuth client for API access. OAuth clients enable: - Third-party application integration - Service-to-service authentication - Mobile app authentication - CLI tool access **Choosing the Right Grant Type:** | Use Case | Grant Type | PKCE | Notes | |----------|------------|------|-------| | Web app with backend | `authorization_code` | Optional | Most secure for user-facing apps | | Mobile/Desktop app | `authorization_code` | Required | Public client, no secret storage | | Server-to-server | `client_credentials` | No | For automated services, no user context | | Single-page app | `authorization_code` | Required | Use PKCE instead of implicit | | Long-lived sessions | Add `refresh_token` | - | Combine with primary grant type | **Grant Type Details:** - **authorization_code**: User authorizes app via browser, app exchanges code for tokens - **client_credentials**: Service authenticates directly with client_id/secret (no user) - **refresh_token**: Exchange refresh token for new access token (add to other grants) - **implicit**: *Deprecated* - Use authorization_code + PKCE instead **PKCE Support**: - Enable PKCE for public clients (mobile apps, SPAs) - Supports S256 (SHA-256) and plain challenge methods - Required for clients without client secrets The client secret is returned only once - store it securely!
19471
19551
  * @summary Create OAuth Client
19472
19552
  * @param {string} orgId The unique identifier of the organization.
19473
19553
  * @param {string} projectId The unique identifier of the project.
19474
19554
  * @param {OAuthClientCreate} oAuthClientCreate
19475
19555
  * @param {*} [options] Override http request option.
19476
19556
  * @throws {RequiredError}
19477
- * @memberof OauthClientsApi
19557
+ * @memberof OAuthClientsApi
19478
19558
  */
19479
19559
  public createOAuthClient(orgId: string, projectId: string, oAuthClientCreate: OAuthClientCreate, options?: RawAxiosRequestConfig) {
19480
- return OauthClientsApiFp(this.configuration).createOAuthClient(orgId, projectId, oAuthClientCreate, options).then((request) => request(this.axios, this.basePath));
19560
+ return OAuthClientsApiFp(this.configuration).createOAuthClient(orgId, projectId, oAuthClientCreate, options).then((request) => request(this.axios, this.basePath));
19481
19561
  }
19482
19562
 
19483
19563
  /**
@@ -19488,10 +19568,10 @@ export class OauthClientsApi extends BaseAPI {
19488
19568
  * @param {string} projectId The unique identifier of the project.
19489
19569
  * @param {*} [options] Override http request option.
19490
19570
  * @throws {RequiredError}
19491
- * @memberof OauthClientsApi
19571
+ * @memberof OAuthClientsApi
19492
19572
  */
19493
19573
  public deleteOAuthClient(oauthClientId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig) {
19494
- return OauthClientsApiFp(this.configuration).deleteOAuthClient(oauthClientId, orgId, projectId, options).then((request) => request(this.axios, this.basePath));
19574
+ return OAuthClientsApiFp(this.configuration).deleteOAuthClient(oauthClientId, orgId, projectId, options).then((request) => request(this.axios, this.basePath));
19495
19575
  }
19496
19576
 
19497
19577
  /**
@@ -19502,10 +19582,10 @@ export class OauthClientsApi extends BaseAPI {
19502
19582
  * @param {string} projectId
19503
19583
  * @param {*} [options] Override http request option.
19504
19584
  * @throws {RequiredError}
19505
- * @memberof OauthClientsApi
19585
+ * @memberof OAuthClientsApi
19506
19586
  */
19507
19587
  public getOAuthClient(oauthClientId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig) {
19508
- return OauthClientsApiFp(this.configuration).getOAuthClient(oauthClientId, orgId, projectId, options).then((request) => request(this.axios, this.basePath));
19588
+ return OAuthClientsApiFp(this.configuration).getOAuthClient(oauthClientId, orgId, projectId, options).then((request) => request(this.axios, this.basePath));
19509
19589
  }
19510
19590
 
19511
19591
  /**
@@ -19517,10 +19597,10 @@ export class OauthClientsApi extends BaseAPI {
19517
19597
  * @param {string | null} [cursor] A cursor for pagination. Use the &#x60;next_cursor&#x60; value from the previous response to get the next page of results.
19518
19598
  * @param {*} [options] Override http request option.
19519
19599
  * @throws {RequiredError}
19520
- * @memberof OauthClientsApi
19600
+ * @memberof OAuthClientsApi
19521
19601
  */
19522
19602
  public listOAuthClients(orgId: string, projectId: string, pageLimit?: number | null, cursor?: string | null, options?: RawAxiosRequestConfig) {
19523
- return OauthClientsApiFp(this.configuration).listOAuthClients(orgId, projectId, pageLimit, cursor, options).then((request) => request(this.axios, this.basePath));
19603
+ return OAuthClientsApiFp(this.configuration).listOAuthClients(orgId, projectId, pageLimit, cursor, options).then((request) => request(this.axios, this.basePath));
19524
19604
  }
19525
19605
 
19526
19606
  /**
@@ -19532,10 +19612,10 @@ export class OauthClientsApi extends BaseAPI {
19532
19612
  * @param {string} projectId The project id
19533
19613
  * @param {*} [options] Override http request option.
19534
19614
  * @throws {RequiredError}
19535
- * @memberof OauthClientsApi
19615
+ * @memberof OAuthClientsApi
19536
19616
  */
19537
19617
  public projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId: string, member: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig) {
19538
- return OauthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId, member, orgId, projectId, options).then((request) => request(this.axios, this.basePath));
19618
+ return OAuthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId, member, orgId, projectId, options).then((request) => request(this.axios, this.basePath));
19539
19619
  }
19540
19620
 
19541
19621
  /**
@@ -19547,10 +19627,10 @@ export class OauthClientsApi extends BaseAPI {
19547
19627
  * @param {ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum} [type]
19548
19628
  * @param {*} [options] Override http request option.
19549
19629
  * @throws {RequiredError}
19550
- * @memberof OauthClientsApi
19630
+ * @memberof OAuthClientsApi
19551
19631
  */
19552
19632
  public projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId: string, orgId: string, projectId: string, type?: ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum, options?: RawAxiosRequestConfig) {
19553
- return OauthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId, orgId, projectId, type, options).then((request) => request(this.axios, this.basePath));
19633
+ return OAuthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId, orgId, projectId, type, options).then((request) => request(this.axios, this.basePath));
19554
19634
  }
19555
19635
 
19556
19636
  /**
@@ -19562,10 +19642,10 @@ export class OauthClientsApi extends BaseAPI {
19562
19642
  * @param {BrainApiApiV1IamProjectIAMPermissionTest} brainApiApiV1IamProjectIAMPermissionTest
19563
19643
  * @param {*} [options] Override http request option.
19564
19644
  * @throws {RequiredError}
19565
- * @memberof OauthClientsApi
19645
+ * @memberof OAuthClientsApi
19566
19646
  */
19567
19647
  public projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId: string, orgId: string, projectId: string, brainApiApiV1IamProjectIAMPermissionTest: BrainApiApiV1IamProjectIAMPermissionTest, options?: RawAxiosRequestConfig) {
19568
- return OauthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId, orgId, projectId, brainApiApiV1IamProjectIAMPermissionTest, options).then((request) => request(this.axios, this.basePath));
19648
+ return OAuthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId, orgId, projectId, brainApiApiV1IamProjectIAMPermissionTest, options).then((request) => request(this.axios, this.basePath));
19569
19649
  }
19570
19650
 
19571
19651
  /**
@@ -19578,10 +19658,10 @@ export class OauthClientsApi extends BaseAPI {
19578
19658
  * @param {BrainApiApiV1IamProjectIAMMemberRoleUpdate} brainApiApiV1IamProjectIAMMemberRoleUpdate
19579
19659
  * @param {*} [options] Override http request option.
19580
19660
  * @throws {RequiredError}
19581
- * @memberof OauthClientsApi
19661
+ * @memberof OAuthClientsApi
19582
19662
  */
19583
19663
  public projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId: string, member: string, orgId: string, projectId: string, brainApiApiV1IamProjectIAMMemberRoleUpdate: BrainApiApiV1IamProjectIAMMemberRoleUpdate, options?: RawAxiosRequestConfig) {
19584
- return OauthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId, member, orgId, projectId, brainApiApiV1IamProjectIAMMemberRoleUpdate, options).then((request) => request(this.axios, this.basePath));
19664
+ return OAuthClientsApiFp(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId, member, orgId, projectId, brainApiApiV1IamProjectIAMMemberRoleUpdate, options).then((request) => request(this.axios, this.basePath));
19585
19665
  }
19586
19666
 
19587
19667
  /**
@@ -19593,10 +19673,10 @@ export class OauthClientsApi extends BaseAPI {
19593
19673
  * @param {OAuthClientUpdate} oAuthClientUpdate
19594
19674
  * @param {*} [options] Override http request option.
19595
19675
  * @throws {RequiredError}
19596
- * @memberof OauthClientsApi
19676
+ * @memberof OAuthClientsApi
19597
19677
  */
19598
19678
  public regenerateOAuthClientSecret(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig) {
19599
- return OauthClientsApiFp(this.configuration).regenerateOAuthClientSecret(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then((request) => request(this.axios, this.basePath));
19679
+ return OAuthClientsApiFp(this.configuration).regenerateOAuthClientSecret(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then((request) => request(this.axios, this.basePath));
19600
19680
  }
19601
19681
 
19602
19682
  /**
@@ -19608,10 +19688,10 @@ export class OauthClientsApi extends BaseAPI {
19608
19688
  * @param {OAuthClientUpdate} oAuthClientUpdate
19609
19689
  * @param {*} [options] Override http request option.
19610
19690
  * @throws {RequiredError}
19611
- * @memberof OauthClientsApi
19691
+ * @memberof OAuthClientsApi
19612
19692
  */
19613
19693
  public updateOAuthClient(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig) {
19614
- return OauthClientsApiFp(this.configuration).updateOAuthClient(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then((request) => request(this.axios, this.basePath));
19694
+ return OAuthClientsApiFp(this.configuration).updateOAuthClient(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then((request) => request(this.axios, this.basePath));
19615
19695
  }
19616
19696
  }
19617
19697
 
@@ -20012,7 +20092,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
20012
20092
  };
20013
20093
  },
20014
20094
  /**
20015
- * List all organizations the user has access to
20095
+ * List organizations based on the user\'s relationship to them. Use the `membership` parameter to filter organizations by your access level: - **active**: Organizations you are a member of (default) - **joinable**: Organizations you can request to join - **joinable_by_domain**: Organizations that accept members from your email domain - **joinable_by_invite**: Organizations you have pending invites to This endpoint is useful for: - Displaying the user\'s current organizations - Showing organizations the user can join - Building organization switching interfaces
20016
20096
  * @summary List Organizations
20017
20097
  * @param {OrgMembership} [membership]
20018
20098
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -20465,7 +20545,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
20465
20545
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
20466
20546
  },
20467
20547
  /**
20468
- * List all organizations the user has access to
20548
+ * List organizations based on the user\'s relationship to them. Use the `membership` parameter to filter organizations by your access level: - **active**: Organizations you are a member of (default) - **joinable**: Organizations you can request to join - **joinable_by_domain**: Organizations that accept members from your email domain - **joinable_by_invite**: Organizations you have pending invites to This endpoint is useful for: - Displaying the user\'s current organizations - Showing organizations the user can join - Building organization switching interfaces
20469
20549
  * @summary List Organizations
20470
20550
  * @param {OrgMembership} [membership]
20471
20551
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -20672,7 +20752,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
20672
20752
  return localVarFp.listOrganizationInvites(orgId, show, cursor, pageLimit, options).then((request) => request(axios, basePath));
20673
20753
  },
20674
20754
  /**
20675
- * List all organizations the user has access to
20755
+ * List organizations based on the user\'s relationship to them. Use the `membership` parameter to filter organizations by your access level: - **active**: Organizations you are a member of (default) - **joinable**: Organizations you can request to join - **joinable_by_domain**: Organizations that accept members from your email domain - **joinable_by_invite**: Organizations you have pending invites to This endpoint is useful for: - Displaying the user\'s current organizations - Showing organizations the user can join - Building organization switching interfaces
20676
20756
  * @summary List Organizations
20677
20757
  * @param {OrgMembership} [membership]
20678
20758
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -20876,7 +20956,7 @@ export class OrganizationsApi extends BaseAPI {
20876
20956
  }
20877
20957
 
20878
20958
  /**
20879
- * List all organizations the user has access to
20959
+ * List organizations based on the user\'s relationship to them. Use the `membership` parameter to filter organizations by your access level: - **active**: Organizations you are a member of (default) - **joinable**: Organizations you can request to join - **joinable_by_domain**: Organizations that accept members from your email domain - **joinable_by_invite**: Organizations you have pending invites to This endpoint is useful for: - Displaying the user\'s current organizations - Showing organizations the user can join - Building organization switching interfaces
20880
20960
  * @summary List Organizations
20881
20961
  * @param {OrgMembership} [membership]
20882
20962
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -21030,6 +21110,48 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
21030
21110
  options: localVarRequestOptions,
21031
21111
  };
21032
21112
  },
21113
+ /**
21114
+ * Soft delete a project. Marks the project as deleted without removing it from the database. Requires create_project permission on the owning organization. Args: org_id: The organization ID project_id: The project ID to delete async_db: The database session Returns: The deleted project object
21115
+ * @summary Delete Project
21116
+ * @param {string} orgId
21117
+ * @param {string} projectId
21118
+ * @param {*} [options] Override http request option.
21119
+ * @throws {RequiredError}
21120
+ */
21121
+ deleteProject: async (orgId: string, projectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21122
+ // verify required parameter 'orgId' is not null or undefined
21123
+ assertParamExists('deleteProject', 'orgId', orgId)
21124
+ // verify required parameter 'projectId' is not null or undefined
21125
+ assertParamExists('deleteProject', 'projectId', projectId)
21126
+ const localVarPath = `/org/{org_id}/project/{project_id}`
21127
+ .replace(`{${"org_id"}}`, encodeURIComponent(String(orgId)))
21128
+ .replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)));
21129
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21130
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21131
+ let baseOptions;
21132
+ if (configuration) {
21133
+ baseOptions = configuration.baseOptions;
21134
+ }
21135
+
21136
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
21137
+ const localVarHeaderParameter = {} as any;
21138
+ const localVarQueryParameter = {} as any;
21139
+
21140
+ // authentication HTTPBearer required
21141
+ // http bearer authentication required
21142
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
21143
+
21144
+
21145
+
21146
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21147
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21148
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21149
+
21150
+ return {
21151
+ url: toPathString(localVarUrlObj),
21152
+ options: localVarRequestOptions,
21153
+ };
21154
+ },
21033
21155
  /**
21034
21156
  *
21035
21157
  * @summary Get Project
@@ -21524,6 +21646,20 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
21524
21646
  const localVarOperationServerBasePath = operationServerMap['ProjectsApi.createProject']?.[localVarOperationServerIndex]?.url;
21525
21647
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21526
21648
  },
21649
+ /**
21650
+ * Soft delete a project. Marks the project as deleted without removing it from the database. Requires create_project permission on the owning organization. Args: org_id: The organization ID project_id: The project ID to delete async_db: The database session Returns: The deleted project object
21651
+ * @summary Delete Project
21652
+ * @param {string} orgId
21653
+ * @param {string} projectId
21654
+ * @param {*} [options] Override http request option.
21655
+ * @throws {RequiredError}
21656
+ */
21657
+ async deleteProject(orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>> {
21658
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProject(orgId, projectId, options);
21659
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21660
+ const localVarOperationServerBasePath = operationServerMap['ProjectsApi.deleteProject']?.[localVarOperationServerIndex]?.url;
21661
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21662
+ },
21527
21663
  /**
21528
21664
  *
21529
21665
  * @summary Get Project
@@ -21694,6 +21830,17 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
21694
21830
  createProject(orgId: string, projectCreate: ProjectCreate, options?: any): AxiosPromise<Project> {
21695
21831
  return localVarFp.createProject(orgId, projectCreate, options).then((request) => request(axios, basePath));
21696
21832
  },
21833
+ /**
21834
+ * Soft delete a project. Marks the project as deleted without removing it from the database. Requires create_project permission on the owning organization. Args: org_id: The organization ID project_id: The project ID to delete async_db: The database session Returns: The deleted project object
21835
+ * @summary Delete Project
21836
+ * @param {string} orgId
21837
+ * @param {string} projectId
21838
+ * @param {*} [options] Override http request option.
21839
+ * @throws {RequiredError}
21840
+ */
21841
+ deleteProject(orgId: string, projectId: string, options?: any): AxiosPromise<Project> {
21842
+ return localVarFp.deleteProject(orgId, projectId, options).then((request) => request(axios, basePath));
21843
+ },
21697
21844
  /**
21698
21845
  *
21699
21846
  * @summary Get Project
@@ -21836,6 +21983,19 @@ export class ProjectsApi extends BaseAPI {
21836
21983
  return ProjectsApiFp(this.configuration).createProject(orgId, projectCreate, options).then((request) => request(this.axios, this.basePath));
21837
21984
  }
21838
21985
 
21986
+ /**
21987
+ * Soft delete a project. Marks the project as deleted without removing it from the database. Requires create_project permission on the owning organization. Args: org_id: The organization ID project_id: The project ID to delete async_db: The database session Returns: The deleted project object
21988
+ * @summary Delete Project
21989
+ * @param {string} orgId
21990
+ * @param {string} projectId
21991
+ * @param {*} [options] Override http request option.
21992
+ * @throws {RequiredError}
21993
+ * @memberof ProjectsApi
21994
+ */
21995
+ public deleteProject(orgId: string, projectId: string, options?: RawAxiosRequestConfig) {
21996
+ return ProjectsApiFp(this.configuration).deleteProject(orgId, projectId, options).then((request) => request(this.axios, this.basePath));
21997
+ }
21998
+
21839
21999
  /**
21840
22000
  *
21841
22001
  * @summary Get Project
@@ -23756,21 +23916,21 @@ export type UpdateTagEntityTypeEnum = typeof UpdateTagEntityTypeEnum[keyof typeo
23756
23916
  export const TaskForwardersApiAxiosParamCreator = function (configuration?: Configuration) {
23757
23917
  return {
23758
23918
  /**
23759
- * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Slack messages with task results - Chaining tasks together - Custom integrations Configuration varies by forwarder type: - **webhook**: Requires URL and optional headers - **slack**: Requires webhook URL and channel - **task**: Requires target task ID
23919
+ * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Email notifications with customizable templates - Custom integrations with external systems Configuration varies by forwarder type: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable subject and body templates Use `GET /task_forwarder_type` to retrieve the complete configuration schema for each type.
23760
23920
  * @summary Create Task Forwarder
23761
23921
  * @param {string} orgId The unique identifier of the organization.
23762
23922
  * @param {string} projectId The unique identifier of the project.
23763
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
23923
+ * @param {TaskForwarder} taskForwarder
23764
23924
  * @param {*} [options] Override http request option.
23765
23925
  * @throws {RequiredError}
23766
23926
  */
23767
- createTaskForwarder: async (orgId: string, projectId: string, body: WebhookForwarderCreate | EmailForwarderCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
23927
+ createTaskForwarder: async (orgId: string, projectId: string, taskForwarder: TaskForwarder, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
23768
23928
  // verify required parameter 'orgId' is not null or undefined
23769
23929
  assertParamExists('createTaskForwarder', 'orgId', orgId)
23770
23930
  // verify required parameter 'projectId' is not null or undefined
23771
23931
  assertParamExists('createTaskForwarder', 'projectId', projectId)
23772
- // verify required parameter 'body' is not null or undefined
23773
- assertParamExists('createTaskForwarder', 'body', body)
23932
+ // verify required parameter 'taskForwarder' is not null or undefined
23933
+ assertParamExists('createTaskForwarder', 'taskForwarder', taskForwarder)
23774
23934
  const localVarPath = `/org/{org_id}/project/{project_id}/task_forwarder`
23775
23935
  .replace(`{${"org_id"}}`, encodeURIComponent(String(orgId)))
23776
23936
  .replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)));
@@ -23796,7 +23956,7 @@ export const TaskForwardersApiAxiosParamCreator = function (configuration?: Conf
23796
23956
  setSearchParams(localVarUrlObj, localVarQueryParameter);
23797
23957
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
23798
23958
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
23799
- localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
23959
+ localVarRequestOptions.data = serializeDataIfNeeded(taskForwarder, localVarRequestOptions, configuration)
23800
23960
 
23801
23961
  return {
23802
23962
  url: toPathString(localVarUrlObj),
@@ -23850,7 +24010,7 @@ export const TaskForwardersApiAxiosParamCreator = function (configuration?: Conf
23850
24010
  };
23851
24011
  },
23852
24012
  /**
23853
- * List all available task forwarder types with their configuration schemas. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
24013
+ * List all available task forwarder types with their configuration schemas. **Note**: This endpoint returns a plain array of forwarder types, not a paginated response. All available types are returned in a single request. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
23854
24014
  * @summary List Task Forwarder Types
23855
24015
  * @param {string} orgId The unique identifier of the organization.
23856
24016
  * @param {string} projectId The unique identifier of the project.
@@ -24158,19 +24318,19 @@ export const TaskForwardersApiAxiosParamCreator = function (configuration?: Conf
24158
24318
  * @param {string} taskForwarderId The specific Task to reference.
24159
24319
  * @param {string} orgId The unique identifier of the organization.
24160
24320
  * @param {string} projectId The unique identifier of the project.
24161
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
24321
+ * @param {TaskForwarder1} taskForwarder1
24162
24322
  * @param {*} [options] Override http request option.
24163
24323
  * @throws {RequiredError}
24164
24324
  */
24165
- updateTaskForwarder: async (taskForwarderId: string, orgId: string, projectId: string, body: WebhookForwarderUpdate | EmailForwarderUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24325
+ updateTaskForwarder: async (taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24166
24326
  // verify required parameter 'taskForwarderId' is not null or undefined
24167
24327
  assertParamExists('updateTaskForwarder', 'taskForwarderId', taskForwarderId)
24168
24328
  // verify required parameter 'orgId' is not null or undefined
24169
24329
  assertParamExists('updateTaskForwarder', 'orgId', orgId)
24170
24330
  // verify required parameter 'projectId' is not null or undefined
24171
24331
  assertParamExists('updateTaskForwarder', 'projectId', projectId)
24172
- // verify required parameter 'body' is not null or undefined
24173
- assertParamExists('updateTaskForwarder', 'body', body)
24332
+ // verify required parameter 'taskForwarder1' is not null or undefined
24333
+ assertParamExists('updateTaskForwarder', 'taskForwarder1', taskForwarder1)
24174
24334
  const localVarPath = `/org/{org_id}/project/{project_id}/task_forwarder/{task_forwarder_id}`
24175
24335
  .replace(`{${"task_forwarder_id"}}`, encodeURIComponent(String(taskForwarderId)))
24176
24336
  .replace(`{${"org_id"}}`, encodeURIComponent(String(orgId)))
@@ -24197,7 +24357,7 @@ export const TaskForwardersApiAxiosParamCreator = function (configuration?: Conf
24197
24357
  setSearchParams(localVarUrlObj, localVarQueryParameter);
24198
24358
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24199
24359
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24200
- localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
24360
+ localVarRequestOptions.data = serializeDataIfNeeded(taskForwarder1, localVarRequestOptions, configuration)
24201
24361
 
24202
24362
  return {
24203
24363
  url: toPathString(localVarUrlObj),
@@ -24215,16 +24375,16 @@ export const TaskForwardersApiFp = function(configuration?: Configuration) {
24215
24375
  const localVarAxiosParamCreator = TaskForwardersApiAxiosParamCreator(configuration)
24216
24376
  return {
24217
24377
  /**
24218
- * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Slack messages with task results - Chaining tasks together - Custom integrations Configuration varies by forwarder type: - **webhook**: Requires URL and optional headers - **slack**: Requires webhook URL and channel - **task**: Requires target task ID
24378
+ * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Email notifications with customizable templates - Custom integrations with external systems Configuration varies by forwarder type: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable subject and body templates Use `GET /task_forwarder_type` to retrieve the complete configuration schema for each type.
24219
24379
  * @summary Create Task Forwarder
24220
24380
  * @param {string} orgId The unique identifier of the organization.
24221
24381
  * @param {string} projectId The unique identifier of the project.
24222
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
24382
+ * @param {TaskForwarder} taskForwarder
24223
24383
  * @param {*} [options] Override http request option.
24224
24384
  * @throws {RequiredError}
24225
24385
  */
24226
- async createTaskForwarder(orgId: string, projectId: string, body: WebhookForwarderCreate | EmailForwarderCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseCreatetaskforwarder>> {
24227
- const localVarAxiosArgs = await localVarAxiosParamCreator.createTaskForwarder(orgId, projectId, body, options);
24386
+ async createTaskForwarder(orgId: string, projectId: string, taskForwarder: TaskForwarder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseCreatetaskforwarder>> {
24387
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createTaskForwarder(orgId, projectId, taskForwarder, options);
24228
24388
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24229
24389
  const localVarOperationServerBasePath = operationServerMap['TaskForwardersApi.createTaskForwarder']?.[localVarOperationServerIndex]?.url;
24230
24390
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -24245,7 +24405,7 @@ export const TaskForwardersApiFp = function(configuration?: Configuration) {
24245
24405
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24246
24406
  },
24247
24407
  /**
24248
- * List all available task forwarder types with their configuration schemas. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
24408
+ * List all available task forwarder types with their configuration schemas. **Note**: This endpoint returns a plain array of forwarder types, not a paginated response. All available types are returned in a single request. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
24249
24409
  * @summary List Task Forwarder Types
24250
24410
  * @param {string} orgId The unique identifier of the organization.
24251
24411
  * @param {string} projectId The unique identifier of the project.
@@ -24345,12 +24505,12 @@ export const TaskForwardersApiFp = function(configuration?: Configuration) {
24345
24505
  * @param {string} taskForwarderId The specific Task to reference.
24346
24506
  * @param {string} orgId The unique identifier of the organization.
24347
24507
  * @param {string} projectId The unique identifier of the project.
24348
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
24508
+ * @param {TaskForwarder1} taskForwarder1
24349
24509
  * @param {*} [options] Override http request option.
24350
24510
  * @throws {RequiredError}
24351
24511
  */
24352
- async updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, body: WebhookForwarderUpdate | EmailForwarderUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseUpdatetaskforwarder>> {
24353
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskForwarder(taskForwarderId, orgId, projectId, body, options);
24512
+ async updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseUpdatetaskforwarder>> {
24513
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateTaskForwarder(taskForwarderId, orgId, projectId, taskForwarder1, options);
24354
24514
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24355
24515
  const localVarOperationServerBasePath = operationServerMap['TaskForwardersApi.updateTaskForwarder']?.[localVarOperationServerIndex]?.url;
24356
24516
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -24366,16 +24526,16 @@ export const TaskForwardersApiFactory = function (configuration?: Configuration,
24366
24526
  const localVarFp = TaskForwardersApiFp(configuration)
24367
24527
  return {
24368
24528
  /**
24369
- * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Slack messages with task results - Chaining tasks together - Custom integrations Configuration varies by forwarder type: - **webhook**: Requires URL and optional headers - **slack**: Requires webhook URL and channel - **task**: Requires target task ID
24529
+ * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Email notifications with customizable templates - Custom integrations with external systems Configuration varies by forwarder type: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable subject and body templates Use `GET /task_forwarder_type` to retrieve the complete configuration schema for each type.
24370
24530
  * @summary Create Task Forwarder
24371
24531
  * @param {string} orgId The unique identifier of the organization.
24372
24532
  * @param {string} projectId The unique identifier of the project.
24373
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
24533
+ * @param {TaskForwarder} taskForwarder
24374
24534
  * @param {*} [options] Override http request option.
24375
24535
  * @throws {RequiredError}
24376
24536
  */
24377
- createTaskForwarder(orgId: string, projectId: string, body: WebhookForwarderCreate | EmailForwarderCreate, options?: any): AxiosPromise<ResponseCreatetaskforwarder> {
24378
- return localVarFp.createTaskForwarder(orgId, projectId, body, options).then((request) => request(axios, basePath));
24537
+ createTaskForwarder(orgId: string, projectId: string, taskForwarder: TaskForwarder, options?: any): AxiosPromise<ResponseCreatetaskforwarder> {
24538
+ return localVarFp.createTaskForwarder(orgId, projectId, taskForwarder, options).then((request) => request(axios, basePath));
24379
24539
  },
24380
24540
  /**
24381
24541
  *
@@ -24390,7 +24550,7 @@ export const TaskForwardersApiFactory = function (configuration?: Configuration,
24390
24550
  return localVarFp.getTaskForwarder(taskForwarderId, orgId, projectId, options).then((request) => request(axios, basePath));
24391
24551
  },
24392
24552
  /**
24393
- * List all available task forwarder types with their configuration schemas. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
24553
+ * List all available task forwarder types with their configuration schemas. **Note**: This endpoint returns a plain array of forwarder types, not a paginated response. All available types are returned in a single request. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
24394
24554
  * @summary List Task Forwarder Types
24395
24555
  * @param {string} orgId The unique identifier of the organization.
24396
24556
  * @param {string} projectId The unique identifier of the project.
@@ -24472,12 +24632,12 @@ export const TaskForwardersApiFactory = function (configuration?: Configuration,
24472
24632
  * @param {string} taskForwarderId The specific Task to reference.
24473
24633
  * @param {string} orgId The unique identifier of the organization.
24474
24634
  * @param {string} projectId The unique identifier of the project.
24475
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
24635
+ * @param {TaskForwarder1} taskForwarder1
24476
24636
  * @param {*} [options] Override http request option.
24477
24637
  * @throws {RequiredError}
24478
24638
  */
24479
- updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, body: WebhookForwarderUpdate | EmailForwarderUpdate, options?: any): AxiosPromise<ResponseUpdatetaskforwarder> {
24480
- return localVarFp.updateTaskForwarder(taskForwarderId, orgId, projectId, body, options).then((request) => request(axios, basePath));
24639
+ updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options?: any): AxiosPromise<ResponseUpdatetaskforwarder> {
24640
+ return localVarFp.updateTaskForwarder(taskForwarderId, orgId, projectId, taskForwarder1, options).then((request) => request(axios, basePath));
24481
24641
  },
24482
24642
  };
24483
24643
  };
@@ -24490,17 +24650,17 @@ export const TaskForwardersApiFactory = function (configuration?: Configuration,
24490
24650
  */
24491
24651
  export class TaskForwardersApi extends BaseAPI {
24492
24652
  /**
24493
- * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Slack messages with task results - Chaining tasks together - Custom integrations Configuration varies by forwarder type: - **webhook**: Requires URL and optional headers - **slack**: Requires webhook URL and channel - **task**: Requires target task ID
24653
+ * Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete - Email notifications with customizable templates - Custom integrations with external systems Configuration varies by forwarder type: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable subject and body templates Use `GET /task_forwarder_type` to retrieve the complete configuration schema for each type.
24494
24654
  * @summary Create Task Forwarder
24495
24655
  * @param {string} orgId The unique identifier of the organization.
24496
24656
  * @param {string} projectId The unique identifier of the project.
24497
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
24657
+ * @param {TaskForwarder} taskForwarder
24498
24658
  * @param {*} [options] Override http request option.
24499
24659
  * @throws {RequiredError}
24500
24660
  * @memberof TaskForwardersApi
24501
24661
  */
24502
- public createTaskForwarder(orgId: string, projectId: string, body: WebhookForwarderCreate | EmailForwarderCreate, options?: RawAxiosRequestConfig) {
24503
- return TaskForwardersApiFp(this.configuration).createTaskForwarder(orgId, projectId, body, options).then((request) => request(this.axios, this.basePath));
24662
+ public createTaskForwarder(orgId: string, projectId: string, taskForwarder: TaskForwarder, options?: RawAxiosRequestConfig) {
24663
+ return TaskForwardersApiFp(this.configuration).createTaskForwarder(orgId, projectId, taskForwarder, options).then((request) => request(this.axios, this.basePath));
24504
24664
  }
24505
24665
 
24506
24666
  /**
@@ -24518,7 +24678,7 @@ export class TaskForwardersApi extends BaseAPI {
24518
24678
  }
24519
24679
 
24520
24680
  /**
24521
- * List all available task forwarder types with their configuration schemas. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
24681
+ * List all available task forwarder types with their configuration schemas. **Note**: This endpoint returns a plain array of forwarder types, not a paginated response. All available types are returned in a single request. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.
24522
24682
  * @summary List Task Forwarder Types
24523
24683
  * @param {string} orgId The unique identifier of the organization.
24524
24684
  * @param {string} projectId The unique identifier of the project.
@@ -24612,13 +24772,13 @@ export class TaskForwardersApi extends BaseAPI {
24612
24772
  * @param {string} taskForwarderId The specific Task to reference.
24613
24773
  * @param {string} orgId The unique identifier of the organization.
24614
24774
  * @param {string} projectId The unique identifier of the project.
24615
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
24775
+ * @param {TaskForwarder1} taskForwarder1
24616
24776
  * @param {*} [options] Override http request option.
24617
24777
  * @throws {RequiredError}
24618
24778
  * @memberof TaskForwardersApi
24619
24779
  */
24620
- public updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, body: WebhookForwarderUpdate | EmailForwarderUpdate, options?: RawAxiosRequestConfig) {
24621
- return TaskForwardersApiFp(this.configuration).updateTaskForwarder(taskForwarderId, orgId, projectId, body, options).then((request) => request(this.axios, this.basePath));
24780
+ public updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options?: RawAxiosRequestConfig) {
24781
+ return TaskForwardersApiFp(this.configuration).updateTaskForwarder(taskForwarderId, orgId, projectId, taskForwarder1, options).then((request) => request(this.axios, this.basePath));
24622
24782
  }
24623
24783
  }
24624
24784
 
@@ -24686,7 +24846,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
24686
24846
  };
24687
24847
  },
24688
24848
  /**
24689
- * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality (JSON, image, or audio generation) - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge Task Run Visibility: - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs The Task will be created with an initial revision that becomes automatically active.
24849
+ * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality supporting multiple formats: - `json`: Structured JSON responses (default) - `image`: AI-generated images (requires image-capable model) - `audio`: Voice/audio responses - `pdf`: Formatted PDF documents - `text`: Plain text output - `csv`: Structured CSV data tables - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge **LLM Configuration (`llm_config`):** Model-specific configuration options. Common parameters include: - `temperature` (0.0-2.0): Controls randomness. Lower = more focused, higher = more creative - `top_p` (0.0-1.0): Nucleus sampling. Use either temperature OR top_p, not both - `max_tokens`: Maximum tokens in the response - `quality` (for image models): \"standard\" or \"hd\" - `size` (for image models): e.g., \"1024x1024\", \"1792x1024\" **Output Format (`output_format`):** Define the structure of task outputs. Two syntaxes are supported: *Shorthand syntax* (simple fields): ```json {\"field_name\": \"str\", \"count\": \"int\", \"items\": \"array\"} ``` *Object syntax* (with descriptions and constraints): ```json { \"field_name\": { \"type\": \"str\", \"description\": \"What this field contains\", \"options\": [\"option1\", \"option2\"] } } ``` Supported types: `str`/`string`, `int`/`integer`, `number`, `bool`/`boolean`, `array`, `object` **Task Run Visibility:** - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs **Common Use Cases:** *Structured Data Extraction:* Create tasks with JSON output to extract structured data from unstructured text (e.g., invoice parsing, contact extraction). *Image Generation:* Set `output_modality: \"image\"` with DALL-E or similar models to generate images from text prompts. *Document Analysis with Vision:* Enable `vision_enabled: true` with a vision-capable model to analyze uploaded images or documents. *Knowledge Base Q&A (RAG):* Configure `rag` with collection IDs to ground responses in your organization\'s documents and knowledge. *Automated Reports:* Use `output_modality: \"pdf\"` to generate formatted reports that can be downloaded or emailed. The Task will be created with an initial revision that becomes automatically active.
24690
24850
  * @summary Create a New Task
24691
24851
  * @param {string} orgId The unique identifier of the organization.
24692
24852
  * @param {string} projectId The unique identifier of the project.
@@ -25072,7 +25232,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
25072
25232
  };
25073
25233
  },
25074
25234
  /**
25075
- * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed Fallback Model Information: - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
25235
+ * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed **Response Fields:** *Timing Metrics:* - `input_processor_timing`: Time in seconds spent running input processors (e.g., `0.00015282`) - `llm_call_timing`: Time in seconds for the LLM API call (e.g., `1.346`) *Resource Usage:* - `charged_credits`: Credits charged for this execution as a string (e.g., `\"1.00\"`) - `input_tokens`: Number of input tokens processed - `output_tokens`: Number of output tokens generated - `total_tokens`: Combined token count *Retry & Fallback Information:* - `llm_retries`: Number of retry attempts made before success or failure - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) *Input Data:* - `run_data.submitted`: The original input parameters as submitted This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
25076
25236
  * @summary Fetch a Task Run
25077
25237
  * @param {string} orgId The unique identifier of the organization.
25078
25238
  * @param {string} projectId The unique identifier of the project.
@@ -25122,7 +25282,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
25122
25282
  };
25123
25283
  },
25124
25284
  /**
25125
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
25285
+ * Fetch an individual Task Run file. This endpoint retrieves files associated with a task run, such as: - Input images or audio files submitted for processing - Output images, audio, PDFs, or CSV files generated by the task The file is served with appropriate content type headers for inline viewing or download based on the `inline` parameter.
25126
25286
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
25127
25287
  * @param {string} orgId The unique identifier of the organization.
25128
25288
  * @param {string} projectId The unique identifier of the project.
@@ -25425,7 +25585,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
25425
25585
  };
25426
25586
  },
25427
25587
  /**
25428
- * List all share links for a task. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
25588
+ * List all share links for a task. **Note**: This endpoint returns a plain array of task shares, not a paginated response. All shares for the task are returned in a single request. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
25429
25589
  * @summary List Task Shares
25430
25590
  * @param {string} orgId The unique identifier of the organization.
25431
25591
  * @param {string} projectId The unique identifier of the project.
@@ -25588,11 +25748,12 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
25588
25748
  };
25589
25749
  },
25590
25750
  /**
25591
- * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output_format (JSON, image, or audio) 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing Required: - Input parameters as defined in the task\'s user_prompt - Image file if task has image_required=true Optional: - Specific revision_id or revision_tag for testing or comparison - reporting_group name for segmented analytics - use_fallback_model flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files
25751
+ * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output modality: - `json`: Structured JSON responses - `image`: Generated image files (PNG, JPEG) - `audio`: Generated audio files - `pdf`: Formatted PDF documents - `text`: Plain text responses - `csv`: CSV data files 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing **Request Body:** ⚠️ **IMPORTANT**: The request body must use the `task_input` field (not `input_params`): ```json { \"task_input\": { \"variable_name\": \"value to substitute in user_prompt\" } } ``` The keys in `task_input` should match the `{{variable}}` placeholders defined in your task\'s `user_prompt`. For example, if your prompt contains `{{text}}` and `{{language}}`, your request should be: ```json { \"task_input\": { \"text\": \"Hello world\", \"language\": \"Spanish\" } } ``` **Required:** - `task_input` object with parameters matching the task\'s prompt variables - Image file if task has `image_required=true` **Optional Query Parameters:** - `revision_id` or `revision_tag` for testing or comparison - `reporting_group` name for segmented analytics - `use_fallback_model` flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files **Common Use Cases:** *A/B Testing Revisions:* Compare different prompt versions by explicitly specifying `revision_id` or `revision_tag` for each request, then analyze results. *Gradual Rollouts:* Configure traffic weights on revisions to gradually shift traffic from an old prompt to a new one while monitoring performance. *Fallback Model Strategy:* Use `use_fallback_model=true` to manually switch to the backup model during known primary model outages or rate limits. *Analytics Segmentation:* Pass `reporting_group` to track metrics by customer, feature, or experiment cohort for billing and performance analysis.
25592
25752
  * @summary Run Task
25593
25753
  * @param {string} orgId The unique identifier of the organization.
25594
25754
  * @param {string} projectId The unique identifier of the project.
25595
25755
  * @param {string} taskId The specific Task to reference.
25756
+ * @param {RunTaskRequest} runTaskRequest
25596
25757
  * @param {string | null} [revisionId] Optional Task Revision ID to use for execution. If not provided, an active revision will be selected based on traffic weights.
25597
25758
  * @param {string | null} [revisionTag] Optional Task Revision Tag to use for execution. If not provided, an active revision will be selected based on traffic weights.
25598
25759
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -25600,13 +25761,15 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
25600
25761
  * @param {*} [options] Override http request option.
25601
25762
  * @throws {RequiredError}
25602
25763
  */
25603
- runTask: async (orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25764
+ runTask: async (orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25604
25765
  // verify required parameter 'orgId' is not null or undefined
25605
25766
  assertParamExists('runTask', 'orgId', orgId)
25606
25767
  // verify required parameter 'projectId' is not null or undefined
25607
25768
  assertParamExists('runTask', 'projectId', projectId)
25608
25769
  // verify required parameter 'taskId' is not null or undefined
25609
25770
  assertParamExists('runTask', 'taskId', taskId)
25771
+ // verify required parameter 'runTaskRequest' is not null or undefined
25772
+ assertParamExists('runTask', 'runTaskRequest', runTaskRequest)
25610
25773
  const localVarPath = `/org/{org_id}/project/{project_id}/task/{task_id}/run`
25611
25774
  .replace(`{${"org_id"}}`, encodeURIComponent(String(orgId)))
25612
25775
  .replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)))
@@ -25644,9 +25807,12 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
25644
25807
 
25645
25808
 
25646
25809
 
25810
+ localVarHeaderParameter['Content-Type'] = 'application/json';
25811
+
25647
25812
  setSearchParams(localVarUrlObj, localVarQueryParameter);
25648
25813
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25649
25814
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25815
+ localVarRequestOptions.data = serializeDataIfNeeded(runTaskRequest, localVarRequestOptions, configuration)
25650
25816
 
25651
25817
  return {
25652
25818
  url: toPathString(localVarUrlObj),
@@ -25940,7 +26106,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
25940
26106
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25941
26107
  },
25942
26108
  /**
25943
- * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality (JSON, image, or audio generation) - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge Task Run Visibility: - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs The Task will be created with an initial revision that becomes automatically active.
26109
+ * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality supporting multiple formats: - `json`: Structured JSON responses (default) - `image`: AI-generated images (requires image-capable model) - `audio`: Voice/audio responses - `pdf`: Formatted PDF documents - `text`: Plain text output - `csv`: Structured CSV data tables - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge **LLM Configuration (`llm_config`):** Model-specific configuration options. Common parameters include: - `temperature` (0.0-2.0): Controls randomness. Lower = more focused, higher = more creative - `top_p` (0.0-1.0): Nucleus sampling. Use either temperature OR top_p, not both - `max_tokens`: Maximum tokens in the response - `quality` (for image models): \"standard\" or \"hd\" - `size` (for image models): e.g., \"1024x1024\", \"1792x1024\" **Output Format (`output_format`):** Define the structure of task outputs. Two syntaxes are supported: *Shorthand syntax* (simple fields): ```json {\"field_name\": \"str\", \"count\": \"int\", \"items\": \"array\"} ``` *Object syntax* (with descriptions and constraints): ```json { \"field_name\": { \"type\": \"str\", \"description\": \"What this field contains\", \"options\": [\"option1\", \"option2\"] } } ``` Supported types: `str`/`string`, `int`/`integer`, `number`, `bool`/`boolean`, `array`, `object` **Task Run Visibility:** - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs **Common Use Cases:** *Structured Data Extraction:* Create tasks with JSON output to extract structured data from unstructured text (e.g., invoice parsing, contact extraction). *Image Generation:* Set `output_modality: \"image\"` with DALL-E or similar models to generate images from text prompts. *Document Analysis with Vision:* Enable `vision_enabled: true` with a vision-capable model to analyze uploaded images or documents. *Knowledge Base Q&A (RAG):* Configure `rag` with collection IDs to ground responses in your organization\'s documents and knowledge. *Automated Reports:* Use `output_modality: \"pdf\"` to generate formatted reports that can be downloaded or emailed. The Task will be created with an initial revision that becomes automatically active.
25944
26110
  * @summary Create a New Task
25945
26111
  * @param {string} orgId The unique identifier of the organization.
25946
26112
  * @param {string} projectId The unique identifier of the project.
@@ -26064,7 +26230,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
26064
26230
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26065
26231
  },
26066
26232
  /**
26067
- * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed Fallback Model Information: - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
26233
+ * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed **Response Fields:** *Timing Metrics:* - `input_processor_timing`: Time in seconds spent running input processors (e.g., `0.00015282`) - `llm_call_timing`: Time in seconds for the LLM API call (e.g., `1.346`) *Resource Usage:* - `charged_credits`: Credits charged for this execution as a string (e.g., `\"1.00\"`) - `input_tokens`: Number of input tokens processed - `output_tokens`: Number of output tokens generated - `total_tokens`: Combined token count *Retry & Fallback Information:* - `llm_retries`: Number of retry attempts made before success or failure - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) *Input Data:* - `run_data.submitted`: The original input parameters as submitted This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
26068
26234
  * @summary Fetch a Task Run
26069
26235
  * @param {string} orgId The unique identifier of the organization.
26070
26236
  * @param {string} projectId The unique identifier of the project.
@@ -26080,7 +26246,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
26080
26246
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26081
26247
  },
26082
26248
  /**
26083
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
26249
+ * Fetch an individual Task Run file. This endpoint retrieves files associated with a task run, such as: - Input images or audio files submitted for processing - Output images, audio, PDFs, or CSV files generated by the task The file is served with appropriate content type headers for inline viewing or download based on the `inline` parameter.
26084
26250
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
26085
26251
  * @param {string} orgId The unique identifier of the organization.
26086
26252
  * @param {string} projectId The unique identifier of the project.
@@ -26091,7 +26257,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
26091
26257
  * @param {*} [options] Override http request option.
26092
26258
  * @throws {RequiredError}
26093
26259
  */
26094
- async getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRun>> {
26260
+ async getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
26095
26261
  const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskRunFile(orgId, projectId, taskId, taskRunId, fileName, inline, options);
26096
26262
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26097
26263
  const localVarOperationServerBasePath = operationServerMap['TasksApi.getTaskRunFile']?.[localVarOperationServerIndex]?.url;
@@ -26170,7 +26336,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
26170
26336
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26171
26337
  },
26172
26338
  /**
26173
- * List all share links for a task. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
26339
+ * List all share links for a task. **Note**: This endpoint returns a plain array of task shares, not a paginated response. All shares for the task are returned in a single request. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
26174
26340
  * @summary List Task Shares
26175
26341
  * @param {string} orgId The unique identifier of the organization.
26176
26342
  * @param {string} projectId The unique identifier of the project.
@@ -26220,11 +26386,12 @@ export const TasksApiFp = function(configuration?: Configuration) {
26220
26386
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26221
26387
  },
26222
26388
  /**
26223
- * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output_format (JSON, image, or audio) 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing Required: - Input parameters as defined in the task\'s user_prompt - Image file if task has image_required=true Optional: - Specific revision_id or revision_tag for testing or comparison - reporting_group name for segmented analytics - use_fallback_model flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files
26389
+ * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output modality: - `json`: Structured JSON responses - `image`: Generated image files (PNG, JPEG) - `audio`: Generated audio files - `pdf`: Formatted PDF documents - `text`: Plain text responses - `csv`: CSV data files 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing **Request Body:** ⚠️ **IMPORTANT**: The request body must use the `task_input` field (not `input_params`): ```json { \"task_input\": { \"variable_name\": \"value to substitute in user_prompt\" } } ``` The keys in `task_input` should match the `{{variable}}` placeholders defined in your task\'s `user_prompt`. For example, if your prompt contains `{{text}}` and `{{language}}`, your request should be: ```json { \"task_input\": { \"text\": \"Hello world\", \"language\": \"Spanish\" } } ``` **Required:** - `task_input` object with parameters matching the task\'s prompt variables - Image file if task has `image_required=true` **Optional Query Parameters:** - `revision_id` or `revision_tag` for testing or comparison - `reporting_group` name for segmented analytics - `use_fallback_model` flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files **Common Use Cases:** *A/B Testing Revisions:* Compare different prompt versions by explicitly specifying `revision_id` or `revision_tag` for each request, then analyze results. *Gradual Rollouts:* Configure traffic weights on revisions to gradually shift traffic from an old prompt to a new one while monitoring performance. *Fallback Model Strategy:* Use `use_fallback_model=true` to manually switch to the backup model during known primary model outages or rate limits. *Analytics Segmentation:* Pass `reporting_group` to track metrics by customer, feature, or experiment cohort for billing and performance analysis.
26224
26390
  * @summary Run Task
26225
26391
  * @param {string} orgId The unique identifier of the organization.
26226
26392
  * @param {string} projectId The unique identifier of the project.
26227
26393
  * @param {string} taskId The specific Task to reference.
26394
+ * @param {RunTaskRequest} runTaskRequest
26228
26395
  * @param {string | null} [revisionId] Optional Task Revision ID to use for execution. If not provided, an active revision will be selected based on traffic weights.
26229
26396
  * @param {string | null} [revisionTag] Optional Task Revision Tag to use for execution. If not provided, an active revision will be selected based on traffic weights.
26230
26397
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -26232,8 +26399,8 @@ export const TasksApiFp = function(configuration?: Configuration) {
26232
26399
  * @param {*} [options] Override http request option.
26233
26400
  * @throws {RequiredError}
26234
26401
  */
26235
- async runTask(orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRun>> {
26236
- const localVarAxiosArgs = await localVarAxiosParamCreator.runTask(orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options);
26402
+ async runTask(orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRun>> {
26403
+ const localVarAxiosArgs = await localVarAxiosParamCreator.runTask(orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options);
26237
26404
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26238
26405
  const localVarOperationServerBasePath = operationServerMap['TasksApi.runTask']?.[localVarOperationServerIndex]?.url;
26239
26406
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -26342,7 +26509,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
26342
26509
  return localVarFp.cloneSharedTask(shortId, orgId, projectId, options).then((request) => request(axios, basePath));
26343
26510
  },
26344
26511
  /**
26345
- * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality (JSON, image, or audio generation) - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge Task Run Visibility: - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs The Task will be created with an initial revision that becomes automatically active.
26512
+ * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality supporting multiple formats: - `json`: Structured JSON responses (default) - `image`: AI-generated images (requires image-capable model) - `audio`: Voice/audio responses - `pdf`: Formatted PDF documents - `text`: Plain text output - `csv`: Structured CSV data tables - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge **LLM Configuration (`llm_config`):** Model-specific configuration options. Common parameters include: - `temperature` (0.0-2.0): Controls randomness. Lower = more focused, higher = more creative - `top_p` (0.0-1.0): Nucleus sampling. Use either temperature OR top_p, not both - `max_tokens`: Maximum tokens in the response - `quality` (for image models): \"standard\" or \"hd\" - `size` (for image models): e.g., \"1024x1024\", \"1792x1024\" **Output Format (`output_format`):** Define the structure of task outputs. Two syntaxes are supported: *Shorthand syntax* (simple fields): ```json {\"field_name\": \"str\", \"count\": \"int\", \"items\": \"array\"} ``` *Object syntax* (with descriptions and constraints): ```json { \"field_name\": { \"type\": \"str\", \"description\": \"What this field contains\", \"options\": [\"option1\", \"option2\"] } } ``` Supported types: `str`/`string`, `int`/`integer`, `number`, `bool`/`boolean`, `array`, `object` **Task Run Visibility:** - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs **Common Use Cases:** *Structured Data Extraction:* Create tasks with JSON output to extract structured data from unstructured text (e.g., invoice parsing, contact extraction). *Image Generation:* Set `output_modality: \"image\"` with DALL-E or similar models to generate images from text prompts. *Document Analysis with Vision:* Enable `vision_enabled: true` with a vision-capable model to analyze uploaded images or documents. *Knowledge Base Q&A (RAG):* Configure `rag` with collection IDs to ground responses in your organization\'s documents and knowledge. *Automated Reports:* Use `output_modality: \"pdf\"` to generate formatted reports that can be downloaded or emailed. The Task will be created with an initial revision that becomes automatically active.
26346
26513
  * @summary Create a New Task
26347
26514
  * @param {string} orgId The unique identifier of the organization.
26348
26515
  * @param {string} projectId The unique identifier of the project.
@@ -26442,7 +26609,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
26442
26609
  return localVarFp.getTaskCreditReport(orgId, projectId, taskId, startDate, endDate, showReportingGroup, options).then((request) => request(axios, basePath));
26443
26610
  },
26444
26611
  /**
26445
- * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed Fallback Model Information: - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
26612
+ * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed **Response Fields:** *Timing Metrics:* - `input_processor_timing`: Time in seconds spent running input processors (e.g., `0.00015282`) - `llm_call_timing`: Time in seconds for the LLM API call (e.g., `1.346`) *Resource Usage:* - `charged_credits`: Credits charged for this execution as a string (e.g., `\"1.00\"`) - `input_tokens`: Number of input tokens processed - `output_tokens`: Number of output tokens generated - `total_tokens`: Combined token count *Retry & Fallback Information:* - `llm_retries`: Number of retry attempts made before success or failure - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) *Input Data:* - `run_data.submitted`: The original input parameters as submitted This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
26446
26613
  * @summary Fetch a Task Run
26447
26614
  * @param {string} orgId The unique identifier of the organization.
26448
26615
  * @param {string} projectId The unique identifier of the project.
@@ -26455,7 +26622,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
26455
26622
  return localVarFp.getTaskRun(orgId, projectId, taskId, taskRunId, options).then((request) => request(axios, basePath));
26456
26623
  },
26457
26624
  /**
26458
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
26625
+ * Fetch an individual Task Run file. This endpoint retrieves files associated with a task run, such as: - Input images or audio files submitted for processing - Output images, audio, PDFs, or CSV files generated by the task The file is served with appropriate content type headers for inline viewing or download based on the `inline` parameter.
26459
26626
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
26460
26627
  * @param {string} orgId The unique identifier of the organization.
26461
26628
  * @param {string} projectId The unique identifier of the project.
@@ -26466,7 +26633,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
26466
26633
  * @param {*} [options] Override http request option.
26467
26634
  * @throws {RequiredError}
26468
26635
  */
26469
- getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: any): AxiosPromise<TaskRun> {
26636
+ getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: any): AxiosPromise<any> {
26470
26637
  return localVarFp.getTaskRunFile(orgId, projectId, taskId, taskRunId, fileName, inline, options).then((request) => request(axios, basePath));
26471
26638
  },
26472
26639
  /**
@@ -26530,7 +26697,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
26530
26697
  return localVarFp.getTaskUsageReport(orgId, projectId, taskId, aggregation, errorsOnly, options).then((request) => request(axios, basePath));
26531
26698
  },
26532
26699
  /**
26533
- * List all share links for a task. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
26700
+ * List all share links for a task. **Note**: This endpoint returns a plain array of task shares, not a paginated response. All shares for the task are returned in a single request. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
26534
26701
  * @summary List Task Shares
26535
26702
  * @param {string} orgId The unique identifier of the organization.
26536
26703
  * @param {string} projectId The unique identifier of the project.
@@ -26571,11 +26738,12 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
26571
26738
  return localVarFp.revokeTaskShare(orgId, projectId, taskId, shareId, options).then((request) => request(axios, basePath));
26572
26739
  },
26573
26740
  /**
26574
- * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output_format (JSON, image, or audio) 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing Required: - Input parameters as defined in the task\'s user_prompt - Image file if task has image_required=true Optional: - Specific revision_id or revision_tag for testing or comparison - reporting_group name for segmented analytics - use_fallback_model flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files
26741
+ * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output modality: - `json`: Structured JSON responses - `image`: Generated image files (PNG, JPEG) - `audio`: Generated audio files - `pdf`: Formatted PDF documents - `text`: Plain text responses - `csv`: CSV data files 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing **Request Body:** ⚠️ **IMPORTANT**: The request body must use the `task_input` field (not `input_params`): ```json { \"task_input\": { \"variable_name\": \"value to substitute in user_prompt\" } } ``` The keys in `task_input` should match the `{{variable}}` placeholders defined in your task\'s `user_prompt`. For example, if your prompt contains `{{text}}` and `{{language}}`, your request should be: ```json { \"task_input\": { \"text\": \"Hello world\", \"language\": \"Spanish\" } } ``` **Required:** - `task_input` object with parameters matching the task\'s prompt variables - Image file if task has `image_required=true` **Optional Query Parameters:** - `revision_id` or `revision_tag` for testing or comparison - `reporting_group` name for segmented analytics - `use_fallback_model` flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files **Common Use Cases:** *A/B Testing Revisions:* Compare different prompt versions by explicitly specifying `revision_id` or `revision_tag` for each request, then analyze results. *Gradual Rollouts:* Configure traffic weights on revisions to gradually shift traffic from an old prompt to a new one while monitoring performance. *Fallback Model Strategy:* Use `use_fallback_model=true` to manually switch to the backup model during known primary model outages or rate limits. *Analytics Segmentation:* Pass `reporting_group` to track metrics by customer, feature, or experiment cohort for billing and performance analysis.
26575
26742
  * @summary Run Task
26576
26743
  * @param {string} orgId The unique identifier of the organization.
26577
26744
  * @param {string} projectId The unique identifier of the project.
26578
26745
  * @param {string} taskId The specific Task to reference.
26746
+ * @param {RunTaskRequest} runTaskRequest
26579
26747
  * @param {string | null} [revisionId] Optional Task Revision ID to use for execution. If not provided, an active revision will be selected based on traffic weights.
26580
26748
  * @param {string | null} [revisionTag] Optional Task Revision Tag to use for execution. If not provided, an active revision will be selected based on traffic weights.
26581
26749
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -26583,8 +26751,8 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
26583
26751
  * @param {*} [options] Override http request option.
26584
26752
  * @throws {RequiredError}
26585
26753
  */
26586
- runTask(orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: any): AxiosPromise<TaskRun> {
26587
- return localVarFp.runTask(orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then((request) => request(axios, basePath));
26754
+ runTask(orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: any): AxiosPromise<TaskRun> {
26755
+ return localVarFp.runTask(orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then((request) => request(axios, basePath));
26588
26756
  },
26589
26757
  /**
26590
26758
  * Retrieve a specific member that has been granted direct access to the task.
@@ -26677,7 +26845,7 @@ export class TasksApi extends BaseAPI {
26677
26845
  }
26678
26846
 
26679
26847
  /**
26680
- * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality (JSON, image, or audio generation) - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge Task Run Visibility: - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs The Task will be created with an initial revision that becomes automatically active.
26848
+ * Create a new Task with specified prompts, model configuration, and output format. Tasks are the core building blocks that define how the LLM processes inputs and generates structured outputs. Each Task includes: - System and user prompts that guide the LLM\'s behavior - Input parameters that can be dynamically provided when running the Task - Output format specification that ensures consistent, structured responses - Output modality supporting multiple formats: - `json`: Structured JSON responses (default) - `image`: AI-generated images (requires image-capable model) - `audio`: Voice/audio responses - `pdf`: Formatted PDF documents - `text`: Plain text output - `csv`: Structured CSV data tables - Optional fallback model for improved reliability when primary model fails - Optional task run visibility controls for managing access to task execution history - Optional image processing capabilities - Optional RAG (Retrieval Augmented Generation) for domain-specific knowledge **LLM Configuration (`llm_config`):** Model-specific configuration options. Common parameters include: - `temperature` (0.0-2.0): Controls randomness. Lower = more focused, higher = more creative - `top_p` (0.0-1.0): Nucleus sampling. Use either temperature OR top_p, not both - `max_tokens`: Maximum tokens in the response - `quality` (for image models): \"standard\" or \"hd\" - `size` (for image models): e.g., \"1024x1024\", \"1792x1024\" **Output Format (`output_format`):** Define the structure of task outputs. Two syntaxes are supported: *Shorthand syntax* (simple fields): ```json {\"field_name\": \"str\", \"count\": \"int\", \"items\": \"array\"} ``` *Object syntax* (with descriptions and constraints): ```json { \"field_name\": { \"type\": \"str\", \"description\": \"What this field contains\", \"options\": [\"option1\", \"option2\"] } } ``` Supported types: `str`/`string`, `int`/`integer`, `number`, `bool`/`boolean`, `array`, `object` **Task Run Visibility:** - `owner_only` (default): Only task owners can view all task runs - `editors_and_owners`: Task editors and owners can view all task runs - `all_viewers`: All users with view permission can see all task runs **Common Use Cases:** *Structured Data Extraction:* Create tasks with JSON output to extract structured data from unstructured text (e.g., invoice parsing, contact extraction). *Image Generation:* Set `output_modality: \"image\"` with DALL-E or similar models to generate images from text prompts. *Document Analysis with Vision:* Enable `vision_enabled: true` with a vision-capable model to analyze uploaded images or documents. *Knowledge Base Q&A (RAG):* Configure `rag` with collection IDs to ground responses in your organization\'s documents and knowledge. *Automated Reports:* Use `output_modality: \"pdf\"` to generate formatted reports that can be downloaded or emailed. The Task will be created with an initial revision that becomes automatically active.
26681
26849
  * @summary Create a New Task
26682
26850
  * @param {string} orgId The unique identifier of the organization.
26683
26851
  * @param {string} projectId The unique identifier of the project.
@@ -26793,7 +26961,7 @@ export class TasksApi extends BaseAPI {
26793
26961
  }
26794
26962
 
26795
26963
  /**
26796
- * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed Fallback Model Information: - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
26964
+ * Retrieve detailed information about a specific task run. Task runs provide a complete record of task executions, including: - Input parameters and configuration used - Execution status and timing information - Resource usage metrics (e.g., tokens consumed, credits charged) - Structured output and processing metadata - Error information if the run failed - Fallback model information if the primary model failed **Response Fields:** *Timing Metrics:* - `input_processor_timing`: Time in seconds spent running input processors (e.g., `0.00015282`) - `llm_call_timing`: Time in seconds for the LLM API call (e.g., `1.346`) *Resource Usage:* - `charged_credits`: Credits charged for this execution as a string (e.g., `\"1.00\"`) - `input_tokens`: Number of input tokens processed - `output_tokens`: Number of output tokens generated - `total_tokens`: Combined token count *Retry & Fallback Information:* - `llm_retries`: Number of retry attempts made before success or failure - `used_fallback_model`: Boolean indicating if fallback model was used - `primary_failure_reason`: Reason why the primary model failed (if applicable) - `fallback_llm_model_id`: ID of the fallback model used (if applicable) *Input Data:* - `run_data.submitted`: The original input parameters as submitted This endpoint is useful for: - Monitoring task execution progress - Debugging failed runs and understanding failover behavior - Auditing task usage and performance - Retrieving task results - Analyzing reliability and fallback model usage Errors: - Returns 400 if the task run ID is not a valid UUID format - Returns 422 if the request body fails validation - Returns 404 if the task run is not found - Returns 403 if the user lacks permission to access the task run
26797
26965
  * @summary Fetch a Task Run
26798
26966
  * @param {string} orgId The unique identifier of the organization.
26799
26967
  * @param {string} projectId The unique identifier of the project.
@@ -26808,7 +26976,7 @@ export class TasksApi extends BaseAPI {
26808
26976
  }
26809
26977
 
26810
26978
  /**
26811
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
26979
+ * Fetch an individual Task Run file. This endpoint retrieves files associated with a task run, such as: - Input images or audio files submitted for processing - Output images, audio, PDFs, or CSV files generated by the task The file is served with appropriate content type headers for inline viewing or download based on the `inline` parameter.
26812
26980
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
26813
26981
  * @param {string} orgId The unique identifier of the organization.
26814
26982
  * @param {string} projectId The unique identifier of the project.
@@ -26893,7 +27061,7 @@ export class TasksApi extends BaseAPI {
26893
27061
  }
26894
27062
 
26895
27063
  /**
26896
- * List all share links for a task. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
27064
+ * List all share links for a task. **Note**: This endpoint returns a plain array of task shares, not a paginated response. All shares for the task are returned in a single request. Returns all active and inactive shares created for the specified task, ordered by creation date (most recent first). Each share includes: - Share URL and short ID - Title and description - View count and active status - Expiration date (if set) - Creation and modification timestamps Use this endpoint to manage existing shares, check analytics, or deactivate old shares.
26897
27065
  * @summary List Task Shares
26898
27066
  * @param {string} orgId The unique identifier of the organization.
26899
27067
  * @param {string} projectId The unique identifier of the project.
@@ -26940,11 +27108,12 @@ export class TasksApi extends BaseAPI {
26940
27108
  }
26941
27109
 
26942
27110
  /**
26943
- * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output_format (JSON, image, or audio) 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing Required: - Input parameters as defined in the task\'s user_prompt - Image file if task has image_required=true Optional: - Specific revision_id or revision_tag for testing or comparison - reporting_group name for segmented analytics - use_fallback_model flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files
27111
+ * Run a task with the specified inputs and receive structured output. This endpoint executes the task using its active revision(s) and returns the results. Key features: 1. Automatic revision selection based on traffic weights 2. Structured output matching the task\'s output modality: - `json`: Structured JSON responses - `image`: Generated image files (PNG, JPEG) - `audio`: Generated audio files - `pdf`: Formatted PDF documents - `text`: Plain text responses - `csv`: CSV data files 3. Execution metadata (tokens, timing, credits charged) 4. Support for file uploads when required 5. Automatic fallback to backup model on primary model failures 6. Optional manual fallback model triggering 7. Reporting group tracking for analytics and billing **Request Body:** ⚠️ **IMPORTANT**: The request body must use the `task_input` field (not `input_params`): ```json { \"task_input\": { \"variable_name\": \"value to substitute in user_prompt\" } } ``` The keys in `task_input` should match the `{{variable}}` placeholders defined in your task\'s `user_prompt`. For example, if your prompt contains `{{text}}` and `{{language}}`, your request should be: ```json { \"task_input\": { \"text\": \"Hello world\", \"language\": \"Spanish\" } } ``` **Required:** - `task_input` object with parameters matching the task\'s prompt variables - Image file if task has `image_required=true` **Optional Query Parameters:** - `revision_id` or `revision_tag` for testing or comparison - `reporting_group` name for segmented analytics - `use_fallback_model` flag to manually trigger fallback The response includes: - Structured output matching the task\'s output_format - Execution metadata (tokens used, timing, credits charged) - Fallback model usage information if applicable - Input data for audit purposes - References to any processed files **Common Use Cases:** *A/B Testing Revisions:* Compare different prompt versions by explicitly specifying `revision_id` or `revision_tag` for each request, then analyze results. *Gradual Rollouts:* Configure traffic weights on revisions to gradually shift traffic from an old prompt to a new one while monitoring performance. *Fallback Model Strategy:* Use `use_fallback_model=true` to manually switch to the backup model during known primary model outages or rate limits. *Analytics Segmentation:* Pass `reporting_group` to track metrics by customer, feature, or experiment cohort for billing and performance analysis.
26944
27112
  * @summary Run Task
26945
27113
  * @param {string} orgId The unique identifier of the organization.
26946
27114
  * @param {string} projectId The unique identifier of the project.
26947
27115
  * @param {string} taskId The specific Task to reference.
27116
+ * @param {RunTaskRequest} runTaskRequest
26948
27117
  * @param {string | null} [revisionId] Optional Task Revision ID to use for execution. If not provided, an active revision will be selected based on traffic weights.
26949
27118
  * @param {string | null} [revisionTag] Optional Task Revision Tag to use for execution. If not provided, an active revision will be selected based on traffic weights.
26950
27119
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -26953,8 +27122,8 @@ export class TasksApi extends BaseAPI {
26953
27122
  * @throws {RequiredError}
26954
27123
  * @memberof TasksApi
26955
27124
  */
26956
- public runTask(orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig) {
26957
- return TasksApiFp(this.configuration).runTask(orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then((request) => request(this.axios, this.basePath));
27125
+ public runTask(orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig) {
27126
+ return TasksApiFp(this.configuration).runTask(orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then((request) => request(this.axios, this.basePath));
26958
27127
  }
26959
27128
 
26960
27129
  /**