@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/dist/api.js CHANGED
@@ -77,7 +77,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
77
77
  Object.defineProperty(exports, "__esModule", { value: true });
78
78
  exports.TagOutputFormatInputTypeEnum = exports.TagEntityTypeEnum = exports.StripePlan = exports.PlanStatus = exports.PlanInterval = exports.PermissionCheckFailedErrorResponseReasonEnum = exports.OutputModality = exports.OrganizationMemberAlreadyExistsErrorResponseReasonEnum = exports.OrganizationInviteAlreadyExistsErrorResponseReasonEnum = exports.OrganizationIAMPermissionTestPermissionsEnum = exports.OrganizationIAMMemberRoleUpdateRemoveEnum = exports.OrganizationIAMMemberRoleUpdateAddEnum = exports.OrganizationDomainStatusEnum = exports.OrgMembership = exports.OrgInviteShow = exports.OAuthClientUpdateTokenEndpointAuthMethodEnum = exports.OAuthClientProfile = exports.OAuthClientPKCEChallengeMethod = exports.OAuthClientGrantType = exports.OAuthClientCreateTokenEndpointAuthMethodEnum = exports.OAuthClientAccessTokenType = exports.OAuthClientTokenEndpointAuthMethodEnum = exports.NestedStructureItemTypeEnum = exports.NestedStructureTypeEnum = exports.MultipleRolesNotAllowedErrorResponseReasonEnum = exports.ModelExclusionRuleResponseRuleTypeEnum = exports.ModelExclusionRuleRuleTypeEnum = exports.MissingAuthenticationErrorResponseReasonEnum = exports.MalformedResourceIdentifierErrorResponseReasonEnum = exports.KratosWebhookDetailedMessageTypeEnum = exports.InviteFilter = exports.InvalidSubjectTypeErrorResponseReasonEnum = exports.InvalidRoleErrorResponseReasonEnum = exports.InvalidMemberErrorResponseReasonEnum = exports.InputConversationalGuardrailDefinitionNameEnum = exports.ErrorResponseTypeEnum = exports.DocumentSource = exports.DocumentIAMPermissionTestPermissionsEnum = exports.DocumentIAMMemberRoleUpdateRemoveEnum = exports.DocumentIAMMemberRoleUpdateAddEnum = exports.DatasourceSyncRunStatusEnum = exports.CreationTrendReportGranularityEnum = exports.ComposeInitLanguageEnum = exports.CollectionIAMPermissionTestPermissionsEnum = exports.CollectionIAMMemberRoleUpdateRemoveEnum = exports.CollectionIAMMemberRoleUpdateAddEnum = exports.ChatGuardrailTypeEnum = exports.BrainApiApiV1IamProjectIAMPermissionTestPermissionsEnum = exports.BrainApiApiV1IamProjectIAMMemberRoleUpdateRemoveEnum = exports.BrainApiApiV1IamProjectIAMMemberRoleUpdateAddEnum = void 0;
79
79
  exports.InputProcessorsApi = exports.InputProcessorsApiFactory = exports.InputProcessorsApiFp = exports.InputProcessorsApiAxiosParamCreator = exports.DocumentIamOrgOrgIdProjectProjectIdDocumentDocumentIdIamListMembersTypeEnum = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.DocumentApi = exports.DocumentApiFactory = exports.DocumentApiFp = exports.DocumentApiAxiosParamCreator = exports.ComposeApi = exports.ComposeApiFactory = exports.ComposeApiFp = exports.ComposeApiAxiosParamCreator = exports.CollectionIamOrgOrgIdProjectProjectIdCollectionCollectionIdIamListMembersTypeEnum = exports.CollectionsApi = exports.CollectionsApiFactory = exports.CollectionsApiFp = exports.CollectionsApiAxiosParamCreator = exports.CollectionApi = exports.CollectionApiFactory = exports.CollectionApiFp = exports.CollectionApiAxiosParamCreator = exports.AgentPackApi = exports.AgentPackApiFactory = exports.AgentPackApiFp = exports.AgentPackApiAxiosParamCreator = exports.APIKeysApi = exports.APIKeysApiFactory = exports.APIKeysApiFp = exports.APIKeysApiAxiosParamCreator = exports.UserProfileUpdateJobRoleEnum = exports.UserOAuthClientCreateTokenEndpointAuthMethodEnum = exports.UserOAuthClientCreateTypeEnum = exports.UserJobRoleEnum = exports.TaskUpdateTaskRunVisibilityEnum = exports.TaskRunUsageReportAggregationEnum = exports.TaskRunTimingReportAggregationEnum = exports.TaskIAMPermissionTestPermissionsEnum = exports.TaskIAMMemberRoleUpdateRemoveEnum = exports.TaskIAMMemberRoleUpdateAddEnum = exports.TaskForwarderIAMPermissionTestPermissionsEnum = exports.TaskForwarderIAMMemberRoleUpdateRemoveEnum = exports.TaskForwarderIAMMemberRoleUpdateAddEnum = exports.TaskCreateTaskRunVisibilityEnum = exports.TaskTaskRunVisibilityEnum = exports.TagOutputFormatInputItemTypeEnum = void 0;
80
- exports.ScrapeApiFactory = exports.ScrapeApiFp = exports.ScrapeApiAxiosParamCreator = exports.ReportingGroupsApi = exports.ReportingGroupsApiFactory = exports.ReportingGroupsApiFp = exports.ReportingGroupsApiAxiosParamCreator = exports.ProjectIamOrgOrgIdProjectProjectIdIamListMembersTypeEnum = exports.ProjectsApi = exports.ProjectsApiFactory = exports.ProjectsApiFp = exports.ProjectsApiAxiosParamCreator = exports.OrganizationIamListMembersTypeEnum = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum = exports.OauthClientsApi = exports.OauthClientsApiFactory = exports.OauthClientsApiFp = exports.OauthClientsApiAxiosParamCreator = exports.MCPServersApi = exports.MCPServersApiFactory = exports.MCPServersApiFp = exports.MCPServersApiAxiosParamCreator = exports.MCPServerApi = exports.MCPServerApiFactory = exports.MCPServerApiFp = exports.MCPServerApiAxiosParamCreator = exports.MCPRunsApi = exports.MCPRunsApiFactory = exports.MCPRunsApiFp = exports.MCPRunsApiAxiosParamCreator = exports.MCPRunApi = exports.MCPRunApiFactory = exports.MCPRunApiFp = exports.MCPRunApiAxiosParamCreator = exports.ListingsApi = exports.ListingsApiFactory = exports.ListingsApiFp = exports.ListingsApiAxiosParamCreator = exports.RemoveModelExclusionFromProjectRuleTypeEnum = exports.RemoveModelExclusionFromOrgRuleTypeEnum = exports.GetInternalOrgSubscriptionReportStatusEnum = exports.GetInternalOrgSignupsReportGranularityEnum = exports.InternalApi = exports.InternalApiFactory = exports.InternalApiFp = exports.InternalApiAxiosParamCreator = void 0;
80
+ exports.ScrapeApiFactory = exports.ScrapeApiFp = exports.ScrapeApiAxiosParamCreator = exports.ReportingGroupsApi = exports.ReportingGroupsApiFactory = exports.ReportingGroupsApiFp = exports.ReportingGroupsApiAxiosParamCreator = exports.ProjectIamOrgOrgIdProjectProjectIdIamListMembersTypeEnum = exports.ProjectsApi = exports.ProjectsApiFactory = exports.ProjectsApiFp = exports.ProjectsApiAxiosParamCreator = exports.OrganizationIamListMembersTypeEnum = exports.OrganizationsApi = exports.OrganizationsApiFactory = exports.OrganizationsApiFp = exports.OrganizationsApiAxiosParamCreator = exports.ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum = exports.OAuthClientsApi = exports.OAuthClientsApiFactory = exports.OAuthClientsApiFp = exports.OAuthClientsApiAxiosParamCreator = exports.MCPServersApi = exports.MCPServersApiFactory = exports.MCPServersApiFp = exports.MCPServersApiAxiosParamCreator = exports.MCPServerApi = exports.MCPServerApiFactory = exports.MCPServerApiFp = exports.MCPServerApiAxiosParamCreator = exports.MCPRunsApi = exports.MCPRunsApiFactory = exports.MCPRunsApiFp = exports.MCPRunsApiAxiosParamCreator = exports.MCPRunApi = exports.MCPRunApiFactory = exports.MCPRunApiFp = exports.MCPRunApiAxiosParamCreator = exports.ListingsApi = exports.ListingsApiFactory = exports.ListingsApiFp = exports.ListingsApiAxiosParamCreator = exports.RemoveModelExclusionFromProjectRuleTypeEnum = exports.RemoveModelExclusionFromOrgRuleTypeEnum = exports.GetInternalOrgSubscriptionReportStatusEnum = exports.GetInternalOrgSignupsReportGranularityEnum = exports.InternalApi = exports.InternalApiFactory = exports.InternalApiFp = exports.InternalApiAxiosParamCreator = void 0;
81
81
  exports.UsersApi = exports.UsersApiFactory = exports.UsersApiFp = exports.UsersApiAxiosParamCreator = exports.TaskIamOrgOrgIdProjectProjectIdTaskTaskIdIamListMembersTypeEnum = exports.GetTaskUsageReportAggregationEnum = exports.GetTaskTimingReportAggregationEnum = exports.GetTaskRunsStatusEnum = exports.TasksApi = exports.TasksApiFactory = exports.TasksApiFp = exports.TasksApiAxiosParamCreator = exports.TaskForwarderIamOrgOrgIdProjectProjectIdTaskForwarderTaskForwarderIdIamListMembersTypeEnum = exports.TaskForwardersApi = exports.TaskForwardersApiFactory = exports.TaskForwardersApiFp = exports.TaskForwardersApiAxiosParamCreator = exports.UpdateTagEntityTypeEnum = exports.RemoveTagFromEntitiesEntityTypeEnum = exports.ListTagsEntityTypeEnum = exports.GetTagEntityTypeEnum = exports.CreateTagEntityTypeEnum = exports.AddTagToEntitiesEntityTypeEnum = exports.TagsApi = exports.TagsApiFactory = exports.TagsApiFp = exports.TagsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.ScrapeApi = void 0;
82
82
  var axios_1 = require("axios");
83
83
  // Some imports not used depending on template conditions
@@ -702,7 +702,7 @@ var APIKeysApiAxiosParamCreator = function (configuration) {
702
702
  });
703
703
  },
704
704
  /**
705
- * 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.
705
+ * 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.
706
706
  * @summary List API Keys
707
707
  * @param {string} orgId The unique identifier of the organization.
708
708
  * @param {string} projectId The unique identifier of the project.
@@ -749,7 +749,7 @@ var APIKeysApiAxiosParamCreator = function (configuration) {
749
749
  });
750
750
  },
751
751
  /**
752
- * 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.
752
+ * 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.
753
753
  * @summary List API Keys
754
754
  * @param {string} orgId The unique identifier of the organization.
755
755
  * @param {string} projectId The unique identifier of the project.
@@ -958,7 +958,7 @@ var APIKeysApiFp = function (configuration) {
958
958
  });
959
959
  },
960
960
  /**
961
- * 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.
961
+ * 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.
962
962
  * @summary List API Keys
963
963
  * @param {string} orgId The unique identifier of the organization.
964
964
  * @param {string} projectId The unique identifier of the project.
@@ -982,7 +982,7 @@ var APIKeysApiFp = function (configuration) {
982
982
  });
983
983
  },
984
984
  /**
985
- * 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.
985
+ * 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.
986
986
  * @summary List API Keys
987
987
  * @param {string} orgId The unique identifier of the organization.
988
988
  * @param {string} projectId The unique identifier of the project.
@@ -1090,7 +1090,7 @@ var APIKeysApiFactory = function (configuration, basePath, axios) {
1090
1090
  return localVarFp.createApiKey_1(orgId, projectId, apiKeyCreate, options).then(function (request) { return request(axios, basePath); });
1091
1091
  },
1092
1092
  /**
1093
- * 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.
1093
+ * 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.
1094
1094
  * @summary List API Keys
1095
1095
  * @param {string} orgId The unique identifier of the organization.
1096
1096
  * @param {string} projectId The unique identifier of the project.
@@ -1101,7 +1101,7 @@ var APIKeysApiFactory = function (configuration, basePath, axios) {
1101
1101
  return localVarFp.listApiKeys(orgId, projectId, options).then(function (request) { return request(axios, basePath); });
1102
1102
  },
1103
1103
  /**
1104
- * 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.
1104
+ * 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.
1105
1105
  * @summary List API Keys
1106
1106
  * @param {string} orgId The unique identifier of the organization.
1107
1107
  * @param {string} projectId The unique identifier of the project.
@@ -1178,7 +1178,7 @@ var APIKeysApi = /** @class */ (function (_super) {
1178
1178
  return (0, exports.APIKeysApiFp)(this.configuration).createApiKey_1(orgId, projectId, apiKeyCreate, options).then(function (request) { return request(_this.axios, _this.basePath); });
1179
1179
  };
1180
1180
  /**
1181
- * 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.
1181
+ * 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.
1182
1182
  * @summary List API Keys
1183
1183
  * @param {string} orgId The unique identifier of the organization.
1184
1184
  * @param {string} projectId The unique identifier of the project.
@@ -1191,7 +1191,7 @@ var APIKeysApi = /** @class */ (function (_super) {
1191
1191
  return (0, exports.APIKeysApiFp)(this.configuration).listApiKeys(orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
1192
1192
  };
1193
1193
  /**
1194
- * 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.
1194
+ * 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.
1195
1195
  * @summary List API Keys
1196
1196
  * @param {string} orgId The unique identifier of the organization.
1197
1197
  * @param {string} projectId The unique identifier of the project.
@@ -7366,8 +7366,8 @@ var InputProcessorsApiAxiosParamCreator = function (configuration) {
7366
7366
  var _this = this;
7367
7367
  return {
7368
7368
  /**
7369
- * 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
7370
- * @summary List available Input Processors
7369
+ * 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
7370
+ * @summary List Input Processors
7371
7371
  * @param {string} orgId The unique identifier of the organization.
7372
7372
  * @param {string} projectId The unique identifier of the project.
7373
7373
  * @param {*} [options] Override http request option.
@@ -7423,8 +7423,8 @@ var InputProcessorsApiFp = function (configuration) {
7423
7423
  var localVarAxiosParamCreator = (0, exports.InputProcessorsApiAxiosParamCreator)(configuration);
7424
7424
  return {
7425
7425
  /**
7426
- * 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
7427
- * @summary List available Input Processors
7426
+ * 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
7427
+ * @summary List Input Processors
7428
7428
  * @param {string} orgId The unique identifier of the organization.
7429
7429
  * @param {string} projectId The unique identifier of the project.
7430
7430
  * @param {*} [options] Override http request option.
@@ -7457,8 +7457,8 @@ var InputProcessorsApiFactory = function (configuration, basePath, axios) {
7457
7457
  var localVarFp = (0, exports.InputProcessorsApiFp)(configuration);
7458
7458
  return {
7459
7459
  /**
7460
- * 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
7461
- * @summary List available Input Processors
7460
+ * 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
7461
+ * @summary List Input Processors
7462
7462
  * @param {string} orgId The unique identifier of the organization.
7463
7463
  * @param {string} projectId The unique identifier of the project.
7464
7464
  * @param {*} [options] Override http request option.
@@ -7482,8 +7482,8 @@ var InputProcessorsApi = /** @class */ (function (_super) {
7482
7482
  return _super !== null && _super.apply(this, arguments) || this;
7483
7483
  }
7484
7484
  /**
7485
- * 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
7486
- * @summary List available Input Processors
7485
+ * 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
7486
+ * @summary List Input Processors
7487
7487
  * @param {string} orgId The unique identifier of the organization.
7488
7488
  * @param {string} projectId The unique identifier of the project.
7489
7489
  * @param {*} [options] Override http request option.
@@ -10805,7 +10805,7 @@ var ListingsApiAxiosParamCreator = function (configuration) {
10805
10805
  var _this = this;
10806
10806
  return {
10807
10807
  /**
10808
- * 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.
10808
+ * 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.
10809
10809
  * @summary List Available LLM Models
10810
10810
  * @param {string} orgId The unique identifier of the organization.
10811
10811
  * @param {string} projectId The unique identifier of the project.
@@ -10907,7 +10907,7 @@ var ListingsApiAxiosParamCreator = function (configuration) {
10907
10907
  });
10908
10908
  },
10909
10909
  /**
10910
- * 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.
10910
+ * 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.
10911
10911
  * @summary List Available Guardrails
10912
10912
  * @param {string} orgId The unique identifier of the organization.
10913
10913
  * @param {string} projectId The unique identifier of the project.
@@ -10954,7 +10954,7 @@ var ListingsApiFp = function (configuration) {
10954
10954
  var localVarAxiosParamCreator = (0, exports.ListingsApiAxiosParamCreator)(configuration);
10955
10955
  return {
10956
10956
  /**
10957
- * 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.
10957
+ * 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.
10958
10958
  * @summary List Available LLM Models
10959
10959
  * @param {string} orgId The unique identifier of the organization.
10960
10960
  * @param {string} projectId The unique identifier of the project.
@@ -11004,7 +11004,7 @@ var ListingsApiFp = function (configuration) {
11004
11004
  });
11005
11005
  },
11006
11006
  /**
11007
- * 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.
11007
+ * 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.
11008
11008
  * @summary List Available Guardrails
11009
11009
  * @param {string} orgId The unique identifier of the organization.
11010
11010
  * @param {string} projectId The unique identifier of the project.
@@ -11038,7 +11038,7 @@ var ListingsApiFactory = function (configuration, basePath, axios) {
11038
11038
  var localVarFp = (0, exports.ListingsApiFp)(configuration);
11039
11039
  return {
11040
11040
  /**
11041
- * 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.
11041
+ * 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.
11042
11042
  * @summary List Available LLM Models
11043
11043
  * @param {string} orgId The unique identifier of the organization.
11044
11044
  * @param {string} projectId The unique identifier of the project.
@@ -11062,7 +11062,7 @@ var ListingsApiFactory = function (configuration, basePath, axios) {
11062
11062
  return localVarFp.getModel(modelIdOrName, orgId, projectId, options).then(function (request) { return request(axios, basePath); });
11063
11063
  },
11064
11064
  /**
11065
- * 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.
11065
+ * 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.
11066
11066
  * @summary List Available Guardrails
11067
11067
  * @param {string} orgId The unique identifier of the organization.
11068
11068
  * @param {string} projectId The unique identifier of the project.
@@ -11087,7 +11087,7 @@ var ListingsApi = /** @class */ (function (_super) {
11087
11087
  return _super !== null && _super.apply(this, arguments) || this;
11088
11088
  }
11089
11089
  /**
11090
- * 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.
11090
+ * 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.
11091
11091
  * @summary List Available LLM Models
11092
11092
  * @param {string} orgId The unique identifier of the organization.
11093
11093
  * @param {string} projectId The unique identifier of the project.
@@ -11115,7 +11115,7 @@ var ListingsApi = /** @class */ (function (_super) {
11115
11115
  return (0, exports.ListingsApiFp)(this.configuration).getModel(modelIdOrName, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
11116
11116
  };
11117
11117
  /**
11118
- * 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.
11118
+ * 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.
11119
11119
  * @summary List Available Guardrails
11120
11120
  * @param {string} orgId The unique identifier of the organization.
11121
11121
  * @param {string} projectId The unique identifier of the project.
@@ -12736,14 +12736,14 @@ var MCPServersApi = /** @class */ (function (_super) {
12736
12736
  }(base_1.BaseAPI));
12737
12737
  exports.MCPServersApi = MCPServersApi;
12738
12738
  /**
12739
- * OauthClientsApi - axios parameter creator
12739
+ * OAuthClientsApi - axios parameter creator
12740
12740
  * @export
12741
12741
  */
12742
- var OauthClientsApiAxiosParamCreator = function (configuration) {
12742
+ var OAuthClientsApiAxiosParamCreator = function (configuration) {
12743
12743
  var _this = this;
12744
12744
  return {
12745
12745
  /**
12746
- * 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!
12746
+ * 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!
12747
12747
  * @summary Create OAuth Client
12748
12748
  * @param {string} orgId The unique identifier of the organization.
12749
12749
  * @param {string} projectId The unique identifier of the project.
@@ -13291,16 +13291,16 @@ var OauthClientsApiAxiosParamCreator = function (configuration) {
13291
13291
  },
13292
13292
  };
13293
13293
  };
13294
- exports.OauthClientsApiAxiosParamCreator = OauthClientsApiAxiosParamCreator;
13294
+ exports.OAuthClientsApiAxiosParamCreator = OAuthClientsApiAxiosParamCreator;
13295
13295
  /**
13296
- * OauthClientsApi - functional programming interface
13296
+ * OAuthClientsApi - functional programming interface
13297
13297
  * @export
13298
13298
  */
13299
- var OauthClientsApiFp = function (configuration) {
13300
- var localVarAxiosParamCreator = (0, exports.OauthClientsApiAxiosParamCreator)(configuration);
13299
+ var OAuthClientsApiFp = function (configuration) {
13300
+ var localVarAxiosParamCreator = (0, exports.OAuthClientsApiAxiosParamCreator)(configuration);
13301
13301
  return {
13302
13302
  /**
13303
- * 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!
13303
+ * 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!
13304
13304
  * @summary Create OAuth Client
13305
13305
  * @param {string} orgId The unique identifier of the organization.
13306
13306
  * @param {string} projectId The unique identifier of the project.
@@ -13318,7 +13318,7 @@ var OauthClientsApiFp = function (configuration) {
13318
13318
  case 1:
13319
13319
  localVarAxiosArgs = _d.sent();
13320
13320
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13321
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.createOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13321
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.createOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13322
13322
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13323
13323
  }
13324
13324
  });
@@ -13343,7 +13343,7 @@ var OauthClientsApiFp = function (configuration) {
13343
13343
  case 1:
13344
13344
  localVarAxiosArgs = _d.sent();
13345
13345
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13346
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.deleteOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13346
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.deleteOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13347
13347
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13348
13348
  }
13349
13349
  });
@@ -13368,7 +13368,7 @@ var OauthClientsApiFp = function (configuration) {
13368
13368
  case 1:
13369
13369
  localVarAxiosArgs = _d.sent();
13370
13370
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13371
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.getOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13371
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.getOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13372
13372
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13373
13373
  }
13374
13374
  });
@@ -13394,7 +13394,7 @@ var OauthClientsApiFp = function (configuration) {
13394
13394
  case 1:
13395
13395
  localVarAxiosArgs = _d.sent();
13396
13396
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13397
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.listOAuthClients']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13397
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.listOAuthClients']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13398
13398
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13399
13399
  }
13400
13400
  });
@@ -13420,7 +13420,7 @@ var OauthClientsApiFp = function (configuration) {
13420
13420
  case 1:
13421
13421
  localVarAxiosArgs = _d.sent();
13422
13422
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13423
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13423
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13424
13424
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13425
13425
  }
13426
13426
  });
@@ -13446,7 +13446,7 @@ var OauthClientsApiFp = function (configuration) {
13446
13446
  case 1:
13447
13447
  localVarAxiosArgs = _d.sent();
13448
13448
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13449
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13449
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13450
13450
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13451
13451
  }
13452
13452
  });
@@ -13472,7 +13472,7 @@ var OauthClientsApiFp = function (configuration) {
13472
13472
  case 1:
13473
13473
  localVarAxiosArgs = _d.sent();
13474
13474
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13475
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13475
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13476
13476
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13477
13477
  }
13478
13478
  });
@@ -13499,7 +13499,7 @@ var OauthClientsApiFp = function (configuration) {
13499
13499
  case 1:
13500
13500
  localVarAxiosArgs = _d.sent();
13501
13501
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13502
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13502
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13503
13503
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13504
13504
  }
13505
13505
  });
@@ -13525,7 +13525,7 @@ var OauthClientsApiFp = function (configuration) {
13525
13525
  case 1:
13526
13526
  localVarAxiosArgs = _d.sent();
13527
13527
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13528
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.regenerateOAuthClientSecret']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13528
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.regenerateOAuthClientSecret']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13529
13529
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13530
13530
  }
13531
13531
  });
@@ -13551,7 +13551,7 @@ var OauthClientsApiFp = function (configuration) {
13551
13551
  case 1:
13552
13552
  localVarAxiosArgs = _d.sent();
13553
13553
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
13554
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OauthClientsApi.updateOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13554
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthClientsApi.updateOAuthClient']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
13555
13555
  return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
13556
13556
  }
13557
13557
  });
@@ -13559,16 +13559,16 @@ var OauthClientsApiFp = function (configuration) {
13559
13559
  },
13560
13560
  };
13561
13561
  };
13562
- exports.OauthClientsApiFp = OauthClientsApiFp;
13562
+ exports.OAuthClientsApiFp = OAuthClientsApiFp;
13563
13563
  /**
13564
- * OauthClientsApi - factory interface
13564
+ * OAuthClientsApi - factory interface
13565
13565
  * @export
13566
13566
  */
13567
- var OauthClientsApiFactory = function (configuration, basePath, axios) {
13568
- var localVarFp = (0, exports.OauthClientsApiFp)(configuration);
13567
+ var OAuthClientsApiFactory = function (configuration, basePath, axios) {
13568
+ var localVarFp = (0, exports.OAuthClientsApiFp)(configuration);
13569
13569
  return {
13570
13570
  /**
13571
- * 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!
13571
+ * 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!
13572
13572
  * @summary Create OAuth Client
13573
13573
  * @param {string} orgId The unique identifier of the organization.
13574
13574
  * @param {string} projectId The unique identifier of the project.
@@ -13697,31 +13697,31 @@ var OauthClientsApiFactory = function (configuration, basePath, axios) {
13697
13697
  },
13698
13698
  };
13699
13699
  };
13700
- exports.OauthClientsApiFactory = OauthClientsApiFactory;
13700
+ exports.OAuthClientsApiFactory = OAuthClientsApiFactory;
13701
13701
  /**
13702
- * OauthClientsApi - object-oriented interface
13702
+ * OAuthClientsApi - object-oriented interface
13703
13703
  * @export
13704
- * @class OauthClientsApi
13704
+ * @class OAuthClientsApi
13705
13705
  * @extends {BaseAPI}
13706
13706
  */
13707
- var OauthClientsApi = /** @class */ (function (_super) {
13708
- __extends(OauthClientsApi, _super);
13709
- function OauthClientsApi() {
13707
+ var OAuthClientsApi = /** @class */ (function (_super) {
13708
+ __extends(OAuthClientsApi, _super);
13709
+ function OAuthClientsApi() {
13710
13710
  return _super !== null && _super.apply(this, arguments) || this;
13711
13711
  }
13712
13712
  /**
13713
- * 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!
13713
+ * 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!
13714
13714
  * @summary Create OAuth Client
13715
13715
  * @param {string} orgId The unique identifier of the organization.
13716
13716
  * @param {string} projectId The unique identifier of the project.
13717
13717
  * @param {OAuthClientCreate} oAuthClientCreate
13718
13718
  * @param {*} [options] Override http request option.
13719
13719
  * @throws {RequiredError}
13720
- * @memberof OauthClientsApi
13720
+ * @memberof OAuthClientsApi
13721
13721
  */
13722
- OauthClientsApi.prototype.createOAuthClient = function (orgId, projectId, oAuthClientCreate, options) {
13722
+ OAuthClientsApi.prototype.createOAuthClient = function (orgId, projectId, oAuthClientCreate, options) {
13723
13723
  var _this = this;
13724
- return (0, exports.OauthClientsApiFp)(this.configuration).createOAuthClient(orgId, projectId, oAuthClientCreate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13724
+ return (0, exports.OAuthClientsApiFp)(this.configuration).createOAuthClient(orgId, projectId, oAuthClientCreate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13725
13725
  };
13726
13726
  /**
13727
13727
  * Delete an OAuth client and revoke all access. This will: - Revoke all active tokens - Remove client configuration - Delete access logs This action cannot be undone.
@@ -13731,11 +13731,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13731
13731
  * @param {string} projectId The unique identifier of the project.
13732
13732
  * @param {*} [options] Override http request option.
13733
13733
  * @throws {RequiredError}
13734
- * @memberof OauthClientsApi
13734
+ * @memberof OAuthClientsApi
13735
13735
  */
13736
- OauthClientsApi.prototype.deleteOAuthClient = function (oauthClientId, orgId, projectId, options) {
13736
+ OAuthClientsApi.prototype.deleteOAuthClient = function (oauthClientId, orgId, projectId, options) {
13737
13737
  var _this = this;
13738
- return (0, exports.OauthClientsApiFp)(this.configuration).deleteOAuthClient(oauthClientId, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
13738
+ return (0, exports.OAuthClientsApiFp)(this.configuration).deleteOAuthClient(oauthClientId, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
13739
13739
  };
13740
13740
  /**
13741
13741
  * Retrieve detailed information about a specific OAuth client. Returns: - Client configuration - Allowed grant types and scopes - Redirect URIs - Usage statistics - Last access time Note: Client secret is never returned in responses.
@@ -13745,11 +13745,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13745
13745
  * @param {string} projectId
13746
13746
  * @param {*} [options] Override http request option.
13747
13747
  * @throws {RequiredError}
13748
- * @memberof OauthClientsApi
13748
+ * @memberof OAuthClientsApi
13749
13749
  */
13750
- OauthClientsApi.prototype.getOAuthClient = function (oauthClientId, orgId, projectId, options) {
13750
+ OAuthClientsApi.prototype.getOAuthClient = function (oauthClientId, orgId, projectId, options) {
13751
13751
  var _this = this;
13752
- return (0, exports.OauthClientsApiFp)(this.configuration).getOAuthClient(oauthClientId, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
13752
+ return (0, exports.OAuthClientsApiFp)(this.configuration).getOAuthClient(oauthClientId, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
13753
13753
  };
13754
13754
  /**
13755
13755
  * List all OAuth clients for the organization. Returns clients with: - Basic configuration - Grant types and scopes - Creation and last used dates - Active/inactive status Clients are returned in descending order by creation date.
@@ -13760,11 +13760,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13760
13760
  * @param {string | null} [cursor] A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.
13761
13761
  * @param {*} [options] Override http request option.
13762
13762
  * @throws {RequiredError}
13763
- * @memberof OauthClientsApi
13763
+ * @memberof OAuthClientsApi
13764
13764
  */
13765
- OauthClientsApi.prototype.listOAuthClients = function (orgId, projectId, pageLimit, cursor, options) {
13765
+ OAuthClientsApi.prototype.listOAuthClients = function (orgId, projectId, pageLimit, cursor, options) {
13766
13766
  var _this = this;
13767
- return (0, exports.OauthClientsApiFp)(this.configuration).listOAuthClients(orgId, projectId, pageLimit, cursor, options).then(function (request) { return request(_this.axios, _this.basePath); });
13767
+ return (0, exports.OAuthClientsApiFp)(this.configuration).listOAuthClients(orgId, projectId, pageLimit, cursor, options).then(function (request) { return request(_this.axios, _this.basePath); });
13768
13768
  };
13769
13769
  /**
13770
13770
  * Retrieve a specific member that has been granted direct access to the project.
@@ -13775,11 +13775,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13775
13775
  * @param {string} projectId The project id
13776
13776
  * @param {*} [options] Override http request option.
13777
13777
  * @throws {RequiredError}
13778
- * @memberof OauthClientsApi
13778
+ * @memberof OAuthClientsApi
13779
13779
  */
13780
- OauthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember = function (oauthClientId, member, orgId, projectId, options) {
13780
+ OAuthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember = function (oauthClientId, member, orgId, projectId, options) {
13781
13781
  var _this = this;
13782
- return (0, exports.OauthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId, member, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
13782
+ return (0, exports.OAuthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId, member, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
13783
13783
  };
13784
13784
  /**
13785
13785
  * Lists all members that have been granted direct access to the project.
@@ -13790,11 +13790,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13790
13790
  * @param {ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum} [type]
13791
13791
  * @param {*} [options] Override http request option.
13792
13792
  * @throws {RequiredError}
13793
- * @memberof OauthClientsApi
13793
+ * @memberof OAuthClientsApi
13794
13794
  */
13795
- OauthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers = function (oauthClientId, orgId, projectId, type, options) {
13795
+ OAuthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers = function (oauthClientId, orgId, projectId, type, options) {
13796
13796
  var _this = this;
13797
- return (0, exports.OauthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId, orgId, projectId, type, options).then(function (request) { return request(_this.axios, _this.basePath); });
13797
+ return (0, exports.OAuthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId, orgId, projectId, type, options).then(function (request) { return request(_this.axios, _this.basePath); });
13798
13798
  };
13799
13799
  /**
13800
13800
  * Test the permissions that the caller (or another subject) holds on the project.
@@ -13805,11 +13805,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13805
13805
  * @param {BrainApiApiV1IamProjectIAMPermissionTest} brainApiApiV1IamProjectIAMPermissionTest
13806
13806
  * @param {*} [options] Override http request option.
13807
13807
  * @throws {RequiredError}
13808
- * @memberof OauthClientsApi
13808
+ * @memberof OAuthClientsApi
13809
13809
  */
13810
- OauthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions = function (oauthClientId, orgId, projectId, brainApiApiV1IamProjectIAMPermissionTest, options) {
13810
+ OAuthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions = function (oauthClientId, orgId, projectId, brainApiApiV1IamProjectIAMPermissionTest, options) {
13811
13811
  var _this = this;
13812
- return (0, exports.OauthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId, orgId, projectId, brainApiApiV1IamProjectIAMPermissionTest, options).then(function (request) { return request(_this.axios, _this.basePath); });
13812
+ return (0, exports.OAuthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId, orgId, projectId, brainApiApiV1IamProjectIAMPermissionTest, options).then(function (request) { return request(_this.axios, _this.basePath); });
13813
13813
  };
13814
13814
  /**
13815
13815
  * Update the roles that a member holds on the project.
@@ -13821,11 +13821,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13821
13821
  * @param {BrainApiApiV1IamProjectIAMMemberRoleUpdate} brainApiApiV1IamProjectIAMMemberRoleUpdate
13822
13822
  * @param {*} [options] Override http request option.
13823
13823
  * @throws {RequiredError}
13824
- * @memberof OauthClientsApi
13824
+ * @memberof OAuthClientsApi
13825
13825
  */
13826
- OauthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles = function (oauthClientId, member, orgId, projectId, brainApiApiV1IamProjectIAMMemberRoleUpdate, options) {
13826
+ OAuthClientsApi.prototype.projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles = function (oauthClientId, member, orgId, projectId, brainApiApiV1IamProjectIAMMemberRoleUpdate, options) {
13827
13827
  var _this = this;
13828
- return (0, exports.OauthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId, member, orgId, projectId, brainApiApiV1IamProjectIAMMemberRoleUpdate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13828
+ return (0, exports.OAuthClientsApiFp)(this.configuration).projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId, member, orgId, projectId, brainApiApiV1IamProjectIAMMemberRoleUpdate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13829
13829
  };
13830
13830
  /**
13831
13831
  * Generate a new client secret for an OAuth client. This will: - Invalidate the current secret immediately - Generate a new secure secret - Return the new secret (only once!) Active tokens remain valid but cannot be refreshed with old secret.
@@ -13836,11 +13836,11 @@ var OauthClientsApi = /** @class */ (function (_super) {
13836
13836
  * @param {OAuthClientUpdate} oAuthClientUpdate
13837
13837
  * @param {*} [options] Override http request option.
13838
13838
  * @throws {RequiredError}
13839
- * @memberof OauthClientsApi
13839
+ * @memberof OAuthClientsApi
13840
13840
  */
13841
- OauthClientsApi.prototype.regenerateOAuthClientSecret = function (oauthClientId, orgId, projectId, oAuthClientUpdate, options) {
13841
+ OAuthClientsApi.prototype.regenerateOAuthClientSecret = function (oauthClientId, orgId, projectId, oAuthClientUpdate, options) {
13842
13842
  var _this = this;
13843
- return (0, exports.OauthClientsApiFp)(this.configuration).regenerateOAuthClientSecret(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13843
+ return (0, exports.OAuthClientsApiFp)(this.configuration).regenerateOAuthClientSecret(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13844
13844
  };
13845
13845
  /**
13846
13846
  * Update OAuth client configuration. Modifiable fields: - Name and description - Redirect URIs - Allowed scopes - Trusted status Note: Grant types cannot be changed after creation.
@@ -13851,15 +13851,15 @@ var OauthClientsApi = /** @class */ (function (_super) {
13851
13851
  * @param {OAuthClientUpdate} oAuthClientUpdate
13852
13852
  * @param {*} [options] Override http request option.
13853
13853
  * @throws {RequiredError}
13854
- * @memberof OauthClientsApi
13854
+ * @memberof OAuthClientsApi
13855
13855
  */
13856
- OauthClientsApi.prototype.updateOAuthClient = function (oauthClientId, orgId, projectId, oAuthClientUpdate, options) {
13856
+ OAuthClientsApi.prototype.updateOAuthClient = function (oauthClientId, orgId, projectId, oAuthClientUpdate, options) {
13857
13857
  var _this = this;
13858
- return (0, exports.OauthClientsApiFp)(this.configuration).updateOAuthClient(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13858
+ return (0, exports.OAuthClientsApiFp)(this.configuration).updateOAuthClient(oauthClientId, orgId, projectId, oAuthClientUpdate, options).then(function (request) { return request(_this.axios, _this.basePath); });
13859
13859
  };
13860
- return OauthClientsApi;
13860
+ return OAuthClientsApi;
13861
13861
  }(base_1.BaseAPI));
13862
- exports.OauthClientsApi = OauthClientsApi;
13862
+ exports.OAuthClientsApi = OAuthClientsApi;
13863
13863
  /**
13864
13864
  * @export
13865
13865
  */
@@ -14294,7 +14294,7 @@ var OrganizationsApiAxiosParamCreator = function (configuration) {
14294
14294
  });
14295
14295
  },
14296
14296
  /**
14297
- * List all organizations the user has access to
14297
+ * 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
14298
14298
  * @summary List Organizations
14299
14299
  * @param {OrgMembership} [membership]
14300
14300
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -14863,7 +14863,7 @@ var OrganizationsApiFp = function (configuration) {
14863
14863
  });
14864
14864
  },
14865
14865
  /**
14866
- * List all organizations the user has access to
14866
+ * 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
14867
14867
  * @summary List Organizations
14868
14868
  * @param {OrgMembership} [membership]
14869
14869
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -15140,7 +15140,7 @@ var OrganizationsApiFactory = function (configuration, basePath, axios) {
15140
15140
  return localVarFp.listOrganizationInvites(orgId, show, cursor, pageLimit, options).then(function (request) { return request(axios, basePath); });
15141
15141
  },
15142
15142
  /**
15143
- * List all organizations the user has access to
15143
+ * 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
15144
15144
  * @summary List Organizations
15145
15145
  * @param {OrgMembership} [membership]
15146
15146
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -15348,7 +15348,7 @@ var OrganizationsApi = /** @class */ (function (_super) {
15348
15348
  return (0, exports.OrganizationsApiFp)(this.configuration).listOrganizationInvites(orgId, show, cursor, pageLimit, options).then(function (request) { return request(_this.axios, _this.basePath); });
15349
15349
  };
15350
15350
  /**
15351
- * List all organizations the user has access to
15351
+ * 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
15352
15352
  * @summary List Organizations
15353
15353
  * @param {OrgMembership} [membership]
15354
15354
  * @param {string | null} [cursor] Pagination cursor for the next page of results
@@ -15506,6 +15506,53 @@ var ProjectsApiAxiosParamCreator = function (configuration) {
15506
15506
  });
15507
15507
  });
15508
15508
  },
15509
+ /**
15510
+ * 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
15511
+ * @summary Delete Project
15512
+ * @param {string} orgId
15513
+ * @param {string} projectId
15514
+ * @param {*} [options] Override http request option.
15515
+ * @throws {RequiredError}
15516
+ */
15517
+ deleteProject: function (orgId, projectId, options) {
15518
+ if (options === void 0) { options = {}; }
15519
+ return __awaiter(_this, void 0, void 0, function () {
15520
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
15521
+ return __generator(this, function (_a) {
15522
+ switch (_a.label) {
15523
+ case 0:
15524
+ // verify required parameter 'orgId' is not null or undefined
15525
+ (0, common_1.assertParamExists)('deleteProject', 'orgId', orgId);
15526
+ // verify required parameter 'projectId' is not null or undefined
15527
+ (0, common_1.assertParamExists)('deleteProject', 'projectId', projectId);
15528
+ localVarPath = "/org/{org_id}/project/{project_id}"
15529
+ .replace("{".concat("org_id", "}"), encodeURIComponent(String(orgId)))
15530
+ .replace("{".concat("project_id", "}"), encodeURIComponent(String(projectId)));
15531
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
15532
+ if (configuration) {
15533
+ baseOptions = configuration.baseOptions;
15534
+ }
15535
+ localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
15536
+ localVarHeaderParameter = {};
15537
+ localVarQueryParameter = {};
15538
+ // authentication HTTPBearer required
15539
+ // http bearer authentication required
15540
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
15541
+ case 1:
15542
+ // authentication HTTPBearer required
15543
+ // http bearer authentication required
15544
+ _a.sent();
15545
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
15546
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
15547
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
15548
+ return [2 /*return*/, {
15549
+ url: (0, common_1.toPathString)(localVarUrlObj),
15550
+ options: localVarRequestOptions,
15551
+ }];
15552
+ }
15553
+ });
15554
+ });
15555
+ },
15509
15556
  /**
15510
15557
  *
15511
15558
  * @summary Get Project
@@ -16045,6 +16092,30 @@ var ProjectsApiFp = function (configuration) {
16045
16092
  });
16046
16093
  });
16047
16094
  },
16095
+ /**
16096
+ * 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
16097
+ * @summary Delete Project
16098
+ * @param {string} orgId
16099
+ * @param {string} projectId
16100
+ * @param {*} [options] Override http request option.
16101
+ * @throws {RequiredError}
16102
+ */
16103
+ deleteProject: function (orgId, projectId, options) {
16104
+ var _a, _b, _c;
16105
+ return __awaiter(this, void 0, void 0, function () {
16106
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
16107
+ return __generator(this, function (_d) {
16108
+ switch (_d.label) {
16109
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteProject(orgId, projectId, options)];
16110
+ case 1:
16111
+ localVarAxiosArgs = _d.sent();
16112
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
16113
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProjectsApi.deleteProject']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
16114
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
16115
+ }
16116
+ });
16117
+ });
16118
+ },
16048
16119
  /**
16049
16120
  *
16050
16121
  * @summary Get Project
@@ -16315,6 +16386,17 @@ var ProjectsApiFactory = function (configuration, basePath, axios) {
16315
16386
  createProject: function (orgId, projectCreate, options) {
16316
16387
  return localVarFp.createProject(orgId, projectCreate, options).then(function (request) { return request(axios, basePath); });
16317
16388
  },
16389
+ /**
16390
+ * 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
16391
+ * @summary Delete Project
16392
+ * @param {string} orgId
16393
+ * @param {string} projectId
16394
+ * @param {*} [options] Override http request option.
16395
+ * @throws {RequiredError}
16396
+ */
16397
+ deleteProject: function (orgId, projectId, options) {
16398
+ return localVarFp.deleteProject(orgId, projectId, options).then(function (request) { return request(axios, basePath); });
16399
+ },
16318
16400
  /**
16319
16401
  *
16320
16402
  * @summary Get Project
@@ -16461,6 +16543,19 @@ var ProjectsApi = /** @class */ (function (_super) {
16461
16543
  var _this = this;
16462
16544
  return (0, exports.ProjectsApiFp)(this.configuration).createProject(orgId, projectCreate, options).then(function (request) { return request(_this.axios, _this.basePath); });
16463
16545
  };
16546
+ /**
16547
+ * 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
16548
+ * @summary Delete Project
16549
+ * @param {string} orgId
16550
+ * @param {string} projectId
16551
+ * @param {*} [options] Override http request option.
16552
+ * @throws {RequiredError}
16553
+ * @memberof ProjectsApi
16554
+ */
16555
+ ProjectsApi.prototype.deleteProject = function (orgId, projectId, options) {
16556
+ var _this = this;
16557
+ return (0, exports.ProjectsApiFp)(this.configuration).deleteProject(orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
16558
+ };
16464
16559
  /**
16465
16560
  *
16466
16561
  * @summary Get Project
@@ -18631,15 +18726,15 @@ var TaskForwardersApiAxiosParamCreator = function (configuration) {
18631
18726
  var _this = this;
18632
18727
  return {
18633
18728
  /**
18634
- * 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
18729
+ * 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.
18635
18730
  * @summary Create Task Forwarder
18636
18731
  * @param {string} orgId The unique identifier of the organization.
18637
18732
  * @param {string} projectId The unique identifier of the project.
18638
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
18733
+ * @param {TaskForwarder} taskForwarder
18639
18734
  * @param {*} [options] Override http request option.
18640
18735
  * @throws {RequiredError}
18641
18736
  */
18642
- createTaskForwarder: function (orgId, projectId, body, options) {
18737
+ createTaskForwarder: function (orgId, projectId, taskForwarder, options) {
18643
18738
  if (options === void 0) { options = {}; }
18644
18739
  return __awaiter(_this, void 0, void 0, function () {
18645
18740
  var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -18650,8 +18745,8 @@ var TaskForwardersApiAxiosParamCreator = function (configuration) {
18650
18745
  (0, common_1.assertParamExists)('createTaskForwarder', 'orgId', orgId);
18651
18746
  // verify required parameter 'projectId' is not null or undefined
18652
18747
  (0, common_1.assertParamExists)('createTaskForwarder', 'projectId', projectId);
18653
- // verify required parameter 'body' is not null or undefined
18654
- (0, common_1.assertParamExists)('createTaskForwarder', 'body', body);
18748
+ // verify required parameter 'taskForwarder' is not null or undefined
18749
+ (0, common_1.assertParamExists)('createTaskForwarder', 'taskForwarder', taskForwarder);
18655
18750
  localVarPath = "/org/{org_id}/project/{project_id}/task_forwarder"
18656
18751
  .replace("{".concat("org_id", "}"), encodeURIComponent(String(orgId)))
18657
18752
  .replace("{".concat("project_id", "}"), encodeURIComponent(String(projectId)));
@@ -18673,7 +18768,7 @@ var TaskForwardersApiAxiosParamCreator = function (configuration) {
18673
18768
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
18674
18769
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18675
18770
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
18676
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
18771
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(taskForwarder, localVarRequestOptions, configuration);
18677
18772
  return [2 /*return*/, {
18678
18773
  url: (0, common_1.toPathString)(localVarUrlObj),
18679
18774
  options: localVarRequestOptions,
@@ -18734,7 +18829,7 @@ var TaskForwardersApiAxiosParamCreator = function (configuration) {
18734
18829
  });
18735
18830
  },
18736
18831
  /**
18737
- * 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.
18832
+ * 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.
18738
18833
  * @summary List Task Forwarder Types
18739
18834
  * @param {string} orgId The unique identifier of the organization.
18740
18835
  * @param {string} projectId The unique identifier of the project.
@@ -19067,11 +19162,11 @@ var TaskForwardersApiAxiosParamCreator = function (configuration) {
19067
19162
  * @param {string} taskForwarderId The specific Task to reference.
19068
19163
  * @param {string} orgId The unique identifier of the organization.
19069
19164
  * @param {string} projectId The unique identifier of the project.
19070
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
19165
+ * @param {TaskForwarder1} taskForwarder1
19071
19166
  * @param {*} [options] Override http request option.
19072
19167
  * @throws {RequiredError}
19073
19168
  */
19074
- updateTaskForwarder: function (taskForwarderId, orgId, projectId, body, options) {
19169
+ updateTaskForwarder: function (taskForwarderId, orgId, projectId, taskForwarder1, options) {
19075
19170
  if (options === void 0) { options = {}; }
19076
19171
  return __awaiter(_this, void 0, void 0, function () {
19077
19172
  var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -19084,8 +19179,8 @@ var TaskForwardersApiAxiosParamCreator = function (configuration) {
19084
19179
  (0, common_1.assertParamExists)('updateTaskForwarder', 'orgId', orgId);
19085
19180
  // verify required parameter 'projectId' is not null or undefined
19086
19181
  (0, common_1.assertParamExists)('updateTaskForwarder', 'projectId', projectId);
19087
- // verify required parameter 'body' is not null or undefined
19088
- (0, common_1.assertParamExists)('updateTaskForwarder', 'body', body);
19182
+ // verify required parameter 'taskForwarder1' is not null or undefined
19183
+ (0, common_1.assertParamExists)('updateTaskForwarder', 'taskForwarder1', taskForwarder1);
19089
19184
  localVarPath = "/org/{org_id}/project/{project_id}/task_forwarder/{task_forwarder_id}"
19090
19185
  .replace("{".concat("task_forwarder_id", "}"), encodeURIComponent(String(taskForwarderId)))
19091
19186
  .replace("{".concat("org_id", "}"), encodeURIComponent(String(orgId)))
@@ -19108,7 +19203,7 @@ var TaskForwardersApiAxiosParamCreator = function (configuration) {
19108
19203
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
19109
19204
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
19110
19205
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
19111
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
19206
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(taskForwarder1, localVarRequestOptions, configuration);
19112
19207
  return [2 /*return*/, {
19113
19208
  url: (0, common_1.toPathString)(localVarUrlObj),
19114
19209
  options: localVarRequestOptions,
@@ -19128,21 +19223,21 @@ var TaskForwardersApiFp = function (configuration) {
19128
19223
  var localVarAxiosParamCreator = (0, exports.TaskForwardersApiAxiosParamCreator)(configuration);
19129
19224
  return {
19130
19225
  /**
19131
- * 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
19226
+ * 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.
19132
19227
  * @summary Create Task Forwarder
19133
19228
  * @param {string} orgId The unique identifier of the organization.
19134
19229
  * @param {string} projectId The unique identifier of the project.
19135
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
19230
+ * @param {TaskForwarder} taskForwarder
19136
19231
  * @param {*} [options] Override http request option.
19137
19232
  * @throws {RequiredError}
19138
19233
  */
19139
- createTaskForwarder: function (orgId, projectId, body, options) {
19234
+ createTaskForwarder: function (orgId, projectId, taskForwarder, options) {
19140
19235
  var _a, _b, _c;
19141
19236
  return __awaiter(this, void 0, void 0, function () {
19142
19237
  var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
19143
19238
  return __generator(this, function (_d) {
19144
19239
  switch (_d.label) {
19145
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.createTaskForwarder(orgId, projectId, body, options)];
19240
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createTaskForwarder(orgId, projectId, taskForwarder, options)];
19146
19241
  case 1:
19147
19242
  localVarAxiosArgs = _d.sent();
19148
19243
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -19178,7 +19273,7 @@ var TaskForwardersApiFp = function (configuration) {
19178
19273
  });
19179
19274
  },
19180
19275
  /**
19181
- * 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.
19276
+ * 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.
19182
19277
  * @summary List Task Forwarder Types
19183
19278
  * @param {string} orgId The unique identifier of the organization.
19184
19279
  * @param {string} projectId The unique identifier of the project.
@@ -19338,17 +19433,17 @@ var TaskForwardersApiFp = function (configuration) {
19338
19433
  * @param {string} taskForwarderId The specific Task to reference.
19339
19434
  * @param {string} orgId The unique identifier of the organization.
19340
19435
  * @param {string} projectId The unique identifier of the project.
19341
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
19436
+ * @param {TaskForwarder1} taskForwarder1
19342
19437
  * @param {*} [options] Override http request option.
19343
19438
  * @throws {RequiredError}
19344
19439
  */
19345
- updateTaskForwarder: function (taskForwarderId, orgId, projectId, body, options) {
19440
+ updateTaskForwarder: function (taskForwarderId, orgId, projectId, taskForwarder1, options) {
19346
19441
  var _a, _b, _c;
19347
19442
  return __awaiter(this, void 0, void 0, function () {
19348
19443
  var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
19349
19444
  return __generator(this, function (_d) {
19350
19445
  switch (_d.label) {
19351
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateTaskForwarder(taskForwarderId, orgId, projectId, body, options)];
19446
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateTaskForwarder(taskForwarderId, orgId, projectId, taskForwarder1, options)];
19352
19447
  case 1:
19353
19448
  localVarAxiosArgs = _d.sent();
19354
19449
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -19369,16 +19464,16 @@ var TaskForwardersApiFactory = function (configuration, basePath, axios) {
19369
19464
  var localVarFp = (0, exports.TaskForwardersApiFp)(configuration);
19370
19465
  return {
19371
19466
  /**
19372
- * 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
19467
+ * 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.
19373
19468
  * @summary Create Task Forwarder
19374
19469
  * @param {string} orgId The unique identifier of the organization.
19375
19470
  * @param {string} projectId The unique identifier of the project.
19376
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
19471
+ * @param {TaskForwarder} taskForwarder
19377
19472
  * @param {*} [options] Override http request option.
19378
19473
  * @throws {RequiredError}
19379
19474
  */
19380
- createTaskForwarder: function (orgId, projectId, body, options) {
19381
- return localVarFp.createTaskForwarder(orgId, projectId, body, options).then(function (request) { return request(axios, basePath); });
19475
+ createTaskForwarder: function (orgId, projectId, taskForwarder, options) {
19476
+ return localVarFp.createTaskForwarder(orgId, projectId, taskForwarder, options).then(function (request) { return request(axios, basePath); });
19382
19477
  },
19383
19478
  /**
19384
19479
  *
@@ -19393,7 +19488,7 @@ var TaskForwardersApiFactory = function (configuration, basePath, axios) {
19393
19488
  return localVarFp.getTaskForwarder(taskForwarderId, orgId, projectId, options).then(function (request) { return request(axios, basePath); });
19394
19489
  },
19395
19490
  /**
19396
- * 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.
19491
+ * 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.
19397
19492
  * @summary List Task Forwarder Types
19398
19493
  * @param {string} orgId The unique identifier of the organization.
19399
19494
  * @param {string} projectId The unique identifier of the project.
@@ -19475,12 +19570,12 @@ var TaskForwardersApiFactory = function (configuration, basePath, axios) {
19475
19570
  * @param {string} taskForwarderId The specific Task to reference.
19476
19571
  * @param {string} orgId The unique identifier of the organization.
19477
19572
  * @param {string} projectId The unique identifier of the project.
19478
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
19573
+ * @param {TaskForwarder1} taskForwarder1
19479
19574
  * @param {*} [options] Override http request option.
19480
19575
  * @throws {RequiredError}
19481
19576
  */
19482
- updateTaskForwarder: function (taskForwarderId, orgId, projectId, body, options) {
19483
- return localVarFp.updateTaskForwarder(taskForwarderId, orgId, projectId, body, options).then(function (request) { return request(axios, basePath); });
19577
+ updateTaskForwarder: function (taskForwarderId, orgId, projectId, taskForwarder1, options) {
19578
+ return localVarFp.updateTaskForwarder(taskForwarderId, orgId, projectId, taskForwarder1, options).then(function (request) { return request(axios, basePath); });
19484
19579
  },
19485
19580
  };
19486
19581
  };
@@ -19497,18 +19592,18 @@ var TaskForwardersApi = /** @class */ (function (_super) {
19497
19592
  return _super !== null && _super.apply(this, arguments) || this;
19498
19593
  }
19499
19594
  /**
19500
- * 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
19595
+ * 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.
19501
19596
  * @summary Create Task Forwarder
19502
19597
  * @param {string} orgId The unique identifier of the organization.
19503
19598
  * @param {string} projectId The unique identifier of the project.
19504
- * @param {WebhookForwarderCreate | EmailForwarderCreate} body
19599
+ * @param {TaskForwarder} taskForwarder
19505
19600
  * @param {*} [options] Override http request option.
19506
19601
  * @throws {RequiredError}
19507
19602
  * @memberof TaskForwardersApi
19508
19603
  */
19509
- TaskForwardersApi.prototype.createTaskForwarder = function (orgId, projectId, body, options) {
19604
+ TaskForwardersApi.prototype.createTaskForwarder = function (orgId, projectId, taskForwarder, options) {
19510
19605
  var _this = this;
19511
- return (0, exports.TaskForwardersApiFp)(this.configuration).createTaskForwarder(orgId, projectId, body, options).then(function (request) { return request(_this.axios, _this.basePath); });
19606
+ return (0, exports.TaskForwardersApiFp)(this.configuration).createTaskForwarder(orgId, projectId, taskForwarder, options).then(function (request) { return request(_this.axios, _this.basePath); });
19512
19607
  };
19513
19608
  /**
19514
19609
  *
@@ -19525,7 +19620,7 @@ var TaskForwardersApi = /** @class */ (function (_super) {
19525
19620
  return (0, exports.TaskForwardersApiFp)(this.configuration).getTaskForwarder(taskForwarderId, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
19526
19621
  };
19527
19622
  /**
19528
- * 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.
19623
+ * 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.
19529
19624
  * @summary List Task Forwarder Types
19530
19625
  * @param {string} orgId The unique identifier of the organization.
19531
19626
  * @param {string} projectId The unique identifier of the project.
@@ -19619,14 +19714,14 @@ var TaskForwardersApi = /** @class */ (function (_super) {
19619
19714
  * @param {string} taskForwarderId The specific Task to reference.
19620
19715
  * @param {string} orgId The unique identifier of the organization.
19621
19716
  * @param {string} projectId The unique identifier of the project.
19622
- * @param {WebhookForwarderUpdate | EmailForwarderUpdate} body
19717
+ * @param {TaskForwarder1} taskForwarder1
19623
19718
  * @param {*} [options] Override http request option.
19624
19719
  * @throws {RequiredError}
19625
19720
  * @memberof TaskForwardersApi
19626
19721
  */
19627
- TaskForwardersApi.prototype.updateTaskForwarder = function (taskForwarderId, orgId, projectId, body, options) {
19722
+ TaskForwardersApi.prototype.updateTaskForwarder = function (taskForwarderId, orgId, projectId, taskForwarder1, options) {
19628
19723
  var _this = this;
19629
- return (0, exports.TaskForwardersApiFp)(this.configuration).updateTaskForwarder(taskForwarderId, orgId, projectId, body, options).then(function (request) { return request(_this.axios, _this.basePath); });
19724
+ return (0, exports.TaskForwardersApiFp)(this.configuration).updateTaskForwarder(taskForwarderId, orgId, projectId, taskForwarder1, options).then(function (request) { return request(_this.axios, _this.basePath); });
19630
19725
  };
19631
19726
  return TaskForwardersApi;
19632
19727
  }(base_1.BaseAPI));
@@ -19698,7 +19793,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
19698
19793
  });
19699
19794
  },
19700
19795
  /**
19701
- * 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.
19796
+ * 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.
19702
19797
  * @summary Create a New Task
19703
19798
  * @param {string} orgId The unique identifier of the organization.
19704
19799
  * @param {string} projectId The unique identifier of the project.
@@ -20104,7 +20199,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
20104
20199
  });
20105
20200
  },
20106
20201
  /**
20107
- * 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
20202
+ * 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
20108
20203
  * @summary Fetch a Task Run
20109
20204
  * @param {string} orgId The unique identifier of the organization.
20110
20205
  * @param {string} projectId The unique identifier of the project.
@@ -20159,7 +20254,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
20159
20254
  });
20160
20255
  },
20161
20256
  /**
20162
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
20257
+ * 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.
20163
20258
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
20164
20259
  * @param {string} orgId The unique identifier of the organization.
20165
20260
  * @param {string} projectId The unique identifier of the project.
@@ -20474,7 +20569,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
20474
20569
  });
20475
20570
  },
20476
20571
  /**
20477
- * 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.
20572
+ * 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.
20478
20573
  * @summary List Task Shares
20479
20574
  * @param {string} orgId The unique identifier of the organization.
20480
20575
  * @param {string} projectId The unique identifier of the project.
@@ -20647,11 +20742,12 @@ var TasksApiAxiosParamCreator = function (configuration) {
20647
20742
  });
20648
20743
  },
20649
20744
  /**
20650
- * 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
20745
+ * 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.
20651
20746
  * @summary Run Task
20652
20747
  * @param {string} orgId The unique identifier of the organization.
20653
20748
  * @param {string} projectId The unique identifier of the project.
20654
20749
  * @param {string} taskId The specific Task to reference.
20750
+ * @param {RunTaskRequest} runTaskRequest
20655
20751
  * @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.
20656
20752
  * @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.
20657
20753
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -20659,7 +20755,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
20659
20755
  * @param {*} [options] Override http request option.
20660
20756
  * @throws {RequiredError}
20661
20757
  */
20662
- runTask: function (orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
20758
+ runTask: function (orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
20663
20759
  if (options === void 0) { options = {}; }
20664
20760
  return __awaiter(_this, void 0, void 0, function () {
20665
20761
  var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -20672,6 +20768,8 @@ var TasksApiAxiosParamCreator = function (configuration) {
20672
20768
  (0, common_1.assertParamExists)('runTask', 'projectId', projectId);
20673
20769
  // verify required parameter 'taskId' is not null or undefined
20674
20770
  (0, common_1.assertParamExists)('runTask', 'taskId', taskId);
20771
+ // verify required parameter 'runTaskRequest' is not null or undefined
20772
+ (0, common_1.assertParamExists)('runTask', 'runTaskRequest', runTaskRequest);
20675
20773
  localVarPath = "/org/{org_id}/project/{project_id}/task/{task_id}/run"
20676
20774
  .replace("{".concat("org_id", "}"), encodeURIComponent(String(orgId)))
20677
20775
  .replace("{".concat("project_id", "}"), encodeURIComponent(String(projectId)))
@@ -20702,9 +20800,11 @@ var TasksApiAxiosParamCreator = function (configuration) {
20702
20800
  if (useFallbackModel !== undefined) {
20703
20801
  localVarQueryParameter['use_fallback_model'] = useFallbackModel;
20704
20802
  }
20803
+ localVarHeaderParameter['Content-Type'] = 'application/json';
20705
20804
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
20706
20805
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20707
20806
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
20807
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(runTaskRequest, localVarRequestOptions, configuration);
20708
20808
  return [2 /*return*/, {
20709
20809
  url: (0, common_1.toPathString)(localVarUrlObj),
20710
20810
  options: localVarRequestOptions,
@@ -21031,7 +21131,7 @@ var TasksApiFp = function (configuration) {
21031
21131
  });
21032
21132
  },
21033
21133
  /**
21034
- * 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.
21134
+ * 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.
21035
21135
  * @summary Create a New Task
21036
21136
  * @param {string} orgId The unique identifier of the organization.
21037
21137
  * @param {string} projectId The unique identifier of the project.
@@ -21235,7 +21335,7 @@ var TasksApiFp = function (configuration) {
21235
21335
  });
21236
21336
  },
21237
21337
  /**
21238
- * 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
21338
+ * 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
21239
21339
  * @summary Fetch a Task Run
21240
21340
  * @param {string} orgId The unique identifier of the organization.
21241
21341
  * @param {string} projectId The unique identifier of the project.
@@ -21261,7 +21361,7 @@ var TasksApiFp = function (configuration) {
21261
21361
  });
21262
21362
  },
21263
21363
  /**
21264
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
21364
+ * 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.
21265
21365
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
21266
21366
  * @param {string} orgId The unique identifier of the organization.
21267
21367
  * @param {string} projectId The unique identifier of the project.
@@ -21401,7 +21501,7 @@ var TasksApiFp = function (configuration) {
21401
21501
  });
21402
21502
  },
21403
21503
  /**
21404
- * 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.
21504
+ * 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.
21405
21505
  * @summary List Task Shares
21406
21506
  * @param {string} orgId The unique identifier of the organization.
21407
21507
  * @param {string} projectId The unique identifier of the project.
@@ -21481,11 +21581,12 @@ var TasksApiFp = function (configuration) {
21481
21581
  });
21482
21582
  },
21483
21583
  /**
21484
- * 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
21584
+ * 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.
21485
21585
  * @summary Run Task
21486
21586
  * @param {string} orgId The unique identifier of the organization.
21487
21587
  * @param {string} projectId The unique identifier of the project.
21488
21588
  * @param {string} taskId The specific Task to reference.
21589
+ * @param {RunTaskRequest} runTaskRequest
21489
21590
  * @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.
21490
21591
  * @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.
21491
21592
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -21493,13 +21594,13 @@ var TasksApiFp = function (configuration) {
21493
21594
  * @param {*} [options] Override http request option.
21494
21595
  * @throws {RequiredError}
21495
21596
  */
21496
- runTask: function (orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
21597
+ runTask: function (orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
21497
21598
  var _a, _b, _c;
21498
21599
  return __awaiter(this, void 0, void 0, function () {
21499
21600
  var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
21500
21601
  return __generator(this, function (_d) {
21501
21602
  switch (_d.label) {
21502
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.runTask(orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options)];
21603
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.runTask(orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options)];
21503
21604
  case 1:
21504
21605
  localVarAxiosArgs = _d.sent();
21505
21606
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -21663,7 +21764,7 @@ var TasksApiFactory = function (configuration, basePath, axios) {
21663
21764
  return localVarFp.cloneSharedTask(shortId, orgId, projectId, options).then(function (request) { return request(axios, basePath); });
21664
21765
  },
21665
21766
  /**
21666
- * 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.
21767
+ * 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.
21667
21768
  * @summary Create a New Task
21668
21769
  * @param {string} orgId The unique identifier of the organization.
21669
21770
  * @param {string} projectId The unique identifier of the project.
@@ -21763,7 +21864,7 @@ var TasksApiFactory = function (configuration, basePath, axios) {
21763
21864
  return localVarFp.getTaskCreditReport(orgId, projectId, taskId, startDate, endDate, showReportingGroup, options).then(function (request) { return request(axios, basePath); });
21764
21865
  },
21765
21866
  /**
21766
- * 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
21867
+ * 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
21767
21868
  * @summary Fetch a Task Run
21768
21869
  * @param {string} orgId The unique identifier of the organization.
21769
21870
  * @param {string} projectId The unique identifier of the project.
@@ -21776,7 +21877,7 @@ var TasksApiFactory = function (configuration, basePath, axios) {
21776
21877
  return localVarFp.getTaskRun(orgId, projectId, taskId, taskRunId, options).then(function (request) { return request(axios, basePath); });
21777
21878
  },
21778
21879
  /**
21779
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
21880
+ * 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.
21780
21881
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
21781
21882
  * @param {string} orgId The unique identifier of the organization.
21782
21883
  * @param {string} projectId The unique identifier of the project.
@@ -21851,7 +21952,7 @@ var TasksApiFactory = function (configuration, basePath, axios) {
21851
21952
  return localVarFp.getTaskUsageReport(orgId, projectId, taskId, aggregation, errorsOnly, options).then(function (request) { return request(axios, basePath); });
21852
21953
  },
21853
21954
  /**
21854
- * 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.
21955
+ * 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.
21855
21956
  * @summary List Task Shares
21856
21957
  * @param {string} orgId The unique identifier of the organization.
21857
21958
  * @param {string} projectId The unique identifier of the project.
@@ -21892,11 +21993,12 @@ var TasksApiFactory = function (configuration, basePath, axios) {
21892
21993
  return localVarFp.revokeTaskShare(orgId, projectId, taskId, shareId, options).then(function (request) { return request(axios, basePath); });
21893
21994
  },
21894
21995
  /**
21895
- * 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
21996
+ * 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.
21896
21997
  * @summary Run Task
21897
21998
  * @param {string} orgId The unique identifier of the organization.
21898
21999
  * @param {string} projectId The unique identifier of the project.
21899
22000
  * @param {string} taskId The specific Task to reference.
22001
+ * @param {RunTaskRequest} runTaskRequest
21900
22002
  * @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.
21901
22003
  * @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.
21902
22004
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -21904,8 +22006,8 @@ var TasksApiFactory = function (configuration, basePath, axios) {
21904
22006
  * @param {*} [options] Override http request option.
21905
22007
  * @throws {RequiredError}
21906
22008
  */
21907
- runTask: function (orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
21908
- return localVarFp.runTask(orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then(function (request) { return request(axios, basePath); });
22009
+ runTask: function (orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
22010
+ return localVarFp.runTask(orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then(function (request) { return request(axios, basePath); });
21909
22011
  },
21910
22012
  /**
21911
22013
  * Retrieve a specific member that has been granted direct access to the task.
@@ -22002,7 +22104,7 @@ var TasksApi = /** @class */ (function (_super) {
22002
22104
  return (0, exports.TasksApiFp)(this.configuration).cloneSharedTask(shortId, orgId, projectId, options).then(function (request) { return request(_this.axios, _this.basePath); });
22003
22105
  };
22004
22106
  /**
22005
- * 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.
22107
+ * 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.
22006
22108
  * @summary Create a New Task
22007
22109
  * @param {string} orgId The unique identifier of the organization.
22008
22110
  * @param {string} projectId The unique identifier of the project.
@@ -22118,7 +22220,7 @@ var TasksApi = /** @class */ (function (_super) {
22118
22220
  return (0, exports.TasksApiFp)(this.configuration).getTaskCreditReport(orgId, projectId, taskId, startDate, endDate, showReportingGroup, options).then(function (request) { return request(_this.axios, _this.basePath); });
22119
22221
  };
22120
22222
  /**
22121
- * 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
22223
+ * 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
22122
22224
  * @summary Fetch a Task Run
22123
22225
  * @param {string} orgId The unique identifier of the organization.
22124
22226
  * @param {string} projectId The unique identifier of the project.
@@ -22133,7 +22235,7 @@ var TasksApi = /** @class */ (function (_super) {
22133
22235
  return (0, exports.TasksApiFp)(this.configuration).getTaskRun(orgId, projectId, taskId, taskRunId, options).then(function (request) { return request(_this.axios, _this.basePath); });
22134
22236
  };
22135
22237
  /**
22136
- * Fetch an individual Task Run file. This can be either an image or audio file generated by the task.
22238
+ * 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.
22137
22239
  * @summary Fetch a user submitted file (image or audio) for a given Task Run
22138
22240
  * @param {string} orgId The unique identifier of the organization.
22139
22241
  * @param {string} projectId The unique identifier of the project.
@@ -22218,7 +22320,7 @@ var TasksApi = /** @class */ (function (_super) {
22218
22320
  return (0, exports.TasksApiFp)(this.configuration).getTaskUsageReport(orgId, projectId, taskId, aggregation, errorsOnly, options).then(function (request) { return request(_this.axios, _this.basePath); });
22219
22321
  };
22220
22322
  /**
22221
- * 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.
22323
+ * 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.
22222
22324
  * @summary List Task Shares
22223
22325
  * @param {string} orgId The unique identifier of the organization.
22224
22326
  * @param {string} projectId The unique identifier of the project.
@@ -22265,11 +22367,12 @@ var TasksApi = /** @class */ (function (_super) {
22265
22367
  return (0, exports.TasksApiFp)(this.configuration).revokeTaskShare(orgId, projectId, taskId, shareId, options).then(function (request) { return request(_this.axios, _this.basePath); });
22266
22368
  };
22267
22369
  /**
22268
- * 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
22370
+ * 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.
22269
22371
  * @summary Run Task
22270
22372
  * @param {string} orgId The unique identifier of the organization.
22271
22373
  * @param {string} projectId The unique identifier of the project.
22272
22374
  * @param {string} taskId The specific Task to reference.
22375
+ * @param {RunTaskRequest} runTaskRequest
22273
22376
  * @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.
22274
22377
  * @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.
22275
22378
  * @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
@@ -22278,9 +22381,9 @@ var TasksApi = /** @class */ (function (_super) {
22278
22381
  * @throws {RequiredError}
22279
22382
  * @memberof TasksApi
22280
22383
  */
22281
- TasksApi.prototype.runTask = function (orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
22384
+ TasksApi.prototype.runTask = function (orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options) {
22282
22385
  var _this = this;
22283
- return (0, exports.TasksApiFp)(this.configuration).runTask(orgId, projectId, taskId, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then(function (request) { return request(_this.axios, _this.basePath); });
22386
+ return (0, exports.TasksApiFp)(this.configuration).runTask(orgId, projectId, taskId, runTaskRequest, revisionId, revisionTag, reportingGroup, useFallbackModel, options).then(function (request) { return request(_this.axios, _this.basePath); });
22284
22387
  };
22285
22388
  /**
22286
22389
  * Retrieve a specific member that has been granted direct access to the task.