@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/.openapi-generator-ignore +28 -0
- package/api.ts +319 -150
- package/dist/api.d.ts +238 -112
- package/dist/api.js +257 -154
- package/package.json +4 -6
package/dist/api.d.ts
CHANGED
|
@@ -905,11 +905,6 @@ export interface ConversationalGuardrails {
|
|
|
905
905
|
*/
|
|
906
906
|
'output'?: Array<OutputConversationalGuardrailDefinition>;
|
|
907
907
|
}
|
|
908
|
-
/**
|
|
909
|
-
* @type CreateTaskForwarderRequest
|
|
910
|
-
* @export
|
|
911
|
-
*/
|
|
912
|
-
export type CreateTaskForwarderRequest = EmailForwarderCreate | WebhookForwarderCreate;
|
|
913
908
|
/**
|
|
914
909
|
* Represents a trend report for organization creation.
|
|
915
910
|
* @export
|
|
@@ -3448,6 +3443,12 @@ export interface OAuthClient {
|
|
|
3448
3443
|
* @memberof OAuthClient
|
|
3449
3444
|
*/
|
|
3450
3445
|
'modified': string;
|
|
3446
|
+
/**
|
|
3447
|
+
* Timestamp when the OAuth client was deleted, if applicable.
|
|
3448
|
+
* @type {string}
|
|
3449
|
+
* @memberof OAuthClient
|
|
3450
|
+
*/
|
|
3451
|
+
'deleted'?: string | null;
|
|
3451
3452
|
}
|
|
3452
3453
|
export declare const OAuthClientTokenEndpointAuthMethodEnum: {
|
|
3453
3454
|
readonly ClientSecretBasic: "client_secret_basic";
|
|
@@ -4906,6 +4907,12 @@ export interface Project {
|
|
|
4906
4907
|
* @memberof Project
|
|
4907
4908
|
*/
|
|
4908
4909
|
'agent_access_key'?: string | null;
|
|
4910
|
+
/**
|
|
4911
|
+
*
|
|
4912
|
+
* @type {string}
|
|
4913
|
+
* @memberof Project
|
|
4914
|
+
*/
|
|
4915
|
+
'deleted'?: string | null;
|
|
4909
4916
|
}
|
|
4910
4917
|
/**
|
|
4911
4918
|
*
|
|
@@ -5079,6 +5086,12 @@ export interface ProjectWithDatasources {
|
|
|
5079
5086
|
* @memberof ProjectWithDatasources
|
|
5080
5087
|
*/
|
|
5081
5088
|
'agent_access_key'?: string | null;
|
|
5089
|
+
/**
|
|
5090
|
+
*
|
|
5091
|
+
* @type {string}
|
|
5092
|
+
* @memberof ProjectWithDatasources
|
|
5093
|
+
*/
|
|
5094
|
+
'deleted'?: string | null;
|
|
5082
5095
|
/**
|
|
5083
5096
|
*
|
|
5084
5097
|
* @type {Array<DatasourceConnectionPublic>}
|
|
@@ -5560,6 +5573,15 @@ export type Response403Deleteorganizationinvite = {
|
|
|
5560
5573
|
} & MissingAuthenticationErrorResponse | {
|
|
5561
5574
|
reason: 'PERMISSION_CHECK_FAILED';
|
|
5562
5575
|
} & PermissionCheckFailedErrorResponse;
|
|
5576
|
+
/**
|
|
5577
|
+
* @type Response403Deleteproject
|
|
5578
|
+
* @export
|
|
5579
|
+
*/
|
|
5580
|
+
export type Response403Deleteproject = {
|
|
5581
|
+
reason: 'MISSING_AUTHENTICATION';
|
|
5582
|
+
} & MissingAuthenticationErrorResponse | {
|
|
5583
|
+
reason: 'PERMISSION_CHECK_FAILED';
|
|
5584
|
+
} & PermissionCheckFailedErrorResponse;
|
|
5563
5585
|
/**
|
|
5564
5586
|
* @type Response403Deleteprojectdocument
|
|
5565
5587
|
* @export
|
|
@@ -6170,6 +6192,52 @@ export interface RunData {
|
|
|
6170
6192
|
*/
|
|
6171
6193
|
'submitted': object;
|
|
6172
6194
|
}
|
|
6195
|
+
/**
|
|
6196
|
+
*
|
|
6197
|
+
* @export
|
|
6198
|
+
* @interface RunTaskRequest
|
|
6199
|
+
*/
|
|
6200
|
+
export interface RunTaskRequest {
|
|
6201
|
+
/**
|
|
6202
|
+
* Key-value pairs mapping variable names to their values. Keys must match the variable placeholders in your task\'s user_prompt.
|
|
6203
|
+
* @type {{ [key: string]: any; }}
|
|
6204
|
+
* @memberof RunTaskRequest
|
|
6205
|
+
*/
|
|
6206
|
+
'task_input': {
|
|
6207
|
+
[key: string]: any;
|
|
6208
|
+
};
|
|
6209
|
+
/**
|
|
6210
|
+
* Optional base64-encoded files to include with the task run
|
|
6211
|
+
* @type {Array<RunTaskRequestTaskFilesInner>}
|
|
6212
|
+
* @memberof RunTaskRequest
|
|
6213
|
+
*/
|
|
6214
|
+
'task_files'?: Array<RunTaskRequestTaskFilesInner>;
|
|
6215
|
+
/**
|
|
6216
|
+
* Optional reference ID for tracking this task run
|
|
6217
|
+
* @type {string}
|
|
6218
|
+
* @memberof RunTaskRequest
|
|
6219
|
+
*/
|
|
6220
|
+
'task_reference'?: string;
|
|
6221
|
+
}
|
|
6222
|
+
/**
|
|
6223
|
+
*
|
|
6224
|
+
* @export
|
|
6225
|
+
* @interface RunTaskRequestTaskFilesInner
|
|
6226
|
+
*/
|
|
6227
|
+
export interface RunTaskRequestTaskFilesInner {
|
|
6228
|
+
/**
|
|
6229
|
+
*
|
|
6230
|
+
* @type {string}
|
|
6231
|
+
* @memberof RunTaskRequestTaskFilesInner
|
|
6232
|
+
*/
|
|
6233
|
+
'filename'?: string;
|
|
6234
|
+
/**
|
|
6235
|
+
*
|
|
6236
|
+
* @type {string}
|
|
6237
|
+
* @memberof RunTaskRequestTaskFilesInner
|
|
6238
|
+
*/
|
|
6239
|
+
'content'?: string;
|
|
6240
|
+
}
|
|
6173
6241
|
/**
|
|
6174
6242
|
*
|
|
6175
6243
|
* @export
|
|
@@ -6466,6 +6534,12 @@ export interface Task {
|
|
|
6466
6534
|
* @memberof Task
|
|
6467
6535
|
*/
|
|
6468
6536
|
'modified'?: string | null;
|
|
6537
|
+
/**
|
|
6538
|
+
* Timestamp when the task was deleted, if applicable.
|
|
6539
|
+
* @type {string}
|
|
6540
|
+
* @memberof Task
|
|
6541
|
+
*/
|
|
6542
|
+
'deleted'?: string | null;
|
|
6469
6543
|
/**
|
|
6470
6544
|
* Each update to a Task results in a new Revision being created. Task Revisions are a powerful concept that can be used to assist with A/B testing, comparing responses from different LLM\'s, etc.
|
|
6471
6545
|
* @type {Array<TaskRevision>}
|
|
@@ -6667,6 +6741,16 @@ export declare const TaskCreateTaskRunVisibilityEnum: {
|
|
|
6667
6741
|
readonly AllViewers: "all_viewers";
|
|
6668
6742
|
};
|
|
6669
6743
|
export type TaskCreateTaskRunVisibilityEnum = typeof TaskCreateTaskRunVisibilityEnum[keyof typeof TaskCreateTaskRunVisibilityEnum];
|
|
6744
|
+
/**
|
|
6745
|
+
* @type TaskForwarder
|
|
6746
|
+
* @export
|
|
6747
|
+
*/
|
|
6748
|
+
export type TaskForwarder = EmailForwarderCreate | WebhookForwarderCreate;
|
|
6749
|
+
/**
|
|
6750
|
+
* @type TaskForwarder1
|
|
6751
|
+
* @export
|
|
6752
|
+
*/
|
|
6753
|
+
export type TaskForwarder1 = EmailForwarderUpdate | WebhookForwarderUpdate;
|
|
6670
6754
|
/**
|
|
6671
6755
|
*
|
|
6672
6756
|
* @export
|
|
@@ -7197,6 +7281,12 @@ export interface TaskRun {
|
|
|
7197
7281
|
* @memberof TaskRun
|
|
7198
7282
|
*/
|
|
7199
7283
|
'reference'?: string | null;
|
|
7284
|
+
/**
|
|
7285
|
+
* An optional context ID for grouping related task runs
|
|
7286
|
+
* @type {string}
|
|
7287
|
+
* @memberof TaskRun
|
|
7288
|
+
*/
|
|
7289
|
+
'context_id'?: string | null;
|
|
7200
7290
|
/**
|
|
7201
7291
|
* The unique identifier of the Task Run.
|
|
7202
7292
|
* @type {string}
|
|
@@ -7935,11 +8025,6 @@ export interface UpdateExpiredTrialsResponse {
|
|
|
7935
8025
|
* @export
|
|
7936
8026
|
*/
|
|
7937
8027
|
export type UpdateOrgAvatar403Response = MissingAuthenticationErrorResponse | PermissionCheckFailedErrorResponse;
|
|
7938
|
-
/**
|
|
7939
|
-
* @type UpdateTaskForwarderRequest
|
|
7940
|
-
* @export
|
|
7941
|
-
*/
|
|
7942
|
-
export type UpdateTaskForwarderRequest = EmailForwarderUpdate | WebhookForwarderUpdate;
|
|
7943
8028
|
/**
|
|
7944
8029
|
*
|
|
7945
8030
|
* @export
|
|
@@ -8354,7 +8439,7 @@ export declare const APIKeysApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8354
8439
|
*/
|
|
8355
8440
|
createApiKey_1: (orgId: string, projectId: string, apiKeyCreate: ApiKeyCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8356
8441
|
/**
|
|
8357
|
-
* 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.
|
|
8442
|
+
* 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.
|
|
8358
8443
|
* @summary List API Keys
|
|
8359
8444
|
* @param {string} orgId The unique identifier of the organization.
|
|
8360
8445
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -8363,7 +8448,7 @@ export declare const APIKeysApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8363
8448
|
*/
|
|
8364
8449
|
listApiKeys: (orgId: string, projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8365
8450
|
/**
|
|
8366
|
-
* 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.
|
|
8451
|
+
* 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.
|
|
8367
8452
|
* @summary List API Keys
|
|
8368
8453
|
* @param {string} orgId The unique identifier of the organization.
|
|
8369
8454
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -8418,7 +8503,7 @@ export declare const APIKeysApiFp: (configuration?: Configuration) => {
|
|
|
8418
8503
|
*/
|
|
8419
8504
|
createApiKey_1(orgId: string, projectId: string, apiKeyCreate: ApiKeyCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKey>>;
|
|
8420
8505
|
/**
|
|
8421
|
-
* 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.
|
|
8506
|
+
* 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.
|
|
8422
8507
|
* @summary List API Keys
|
|
8423
8508
|
* @param {string} orgId The unique identifier of the organization.
|
|
8424
8509
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -8427,7 +8512,7 @@ export declare const APIKeysApiFp: (configuration?: Configuration) => {
|
|
|
8427
8512
|
*/
|
|
8428
8513
|
listApiKeys(orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApiKey>>>;
|
|
8429
8514
|
/**
|
|
8430
|
-
* 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.
|
|
8515
|
+
* 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.
|
|
8431
8516
|
* @summary List API Keys
|
|
8432
8517
|
* @param {string} orgId The unique identifier of the organization.
|
|
8433
8518
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -8486,7 +8571,7 @@ export declare const APIKeysApiFactory: (configuration?: Configuration, basePath
|
|
|
8486
8571
|
*/
|
|
8487
8572
|
createApiKey_1(orgId: string, projectId: string, apiKeyCreate: ApiKeyCreate, options?: any): AxiosPromise<ApiKey>;
|
|
8488
8573
|
/**
|
|
8489
|
-
* 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.
|
|
8574
|
+
* 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.
|
|
8490
8575
|
* @summary List API Keys
|
|
8491
8576
|
* @param {string} orgId The unique identifier of the organization.
|
|
8492
8577
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -8495,7 +8580,7 @@ export declare const APIKeysApiFactory: (configuration?: Configuration, basePath
|
|
|
8495
8580
|
*/
|
|
8496
8581
|
listApiKeys(orgId: string, projectId: string, options?: any): AxiosPromise<Array<ApiKey>>;
|
|
8497
8582
|
/**
|
|
8498
|
-
* 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.
|
|
8583
|
+
* 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.
|
|
8499
8584
|
* @summary List API Keys
|
|
8500
8585
|
* @param {string} orgId The unique identifier of the organization.
|
|
8501
8586
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -8558,7 +8643,7 @@ export declare class APIKeysApi extends BaseAPI {
|
|
|
8558
8643
|
*/
|
|
8559
8644
|
createApiKey_1(orgId: string, projectId: string, apiKeyCreate: ApiKeyCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKey, any, {}>>;
|
|
8560
8645
|
/**
|
|
8561
|
-
* 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.
|
|
8646
|
+
* 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.
|
|
8562
8647
|
* @summary List API Keys
|
|
8563
8648
|
* @param {string} orgId The unique identifier of the organization.
|
|
8564
8649
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -8568,7 +8653,7 @@ export declare class APIKeysApi extends BaseAPI {
|
|
|
8568
8653
|
*/
|
|
8569
8654
|
listApiKeys(orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKey[], any, {}>>;
|
|
8570
8655
|
/**
|
|
8571
|
-
* 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.
|
|
8656
|
+
* 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.
|
|
8572
8657
|
* @summary List API Keys
|
|
8573
8658
|
* @param {string} orgId The unique identifier of the organization.
|
|
8574
8659
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -11270,8 +11355,8 @@ export type DocumentIamOrgOrgIdProjectProjectIdDocumentDocumentIdIamListMembersT
|
|
|
11270
11355
|
*/
|
|
11271
11356
|
export declare const InputProcessorsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11272
11357
|
/**
|
|
11273
|
-
* Returns a list of all available input processors that can be used to transform task inputs.
|
|
11274
|
-
* @summary List
|
|
11358
|
+
* 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
|
|
11359
|
+
* @summary List Input Processors
|
|
11275
11360
|
* @param {string} orgId The unique identifier of the organization.
|
|
11276
11361
|
* @param {string} projectId The unique identifier of the project.
|
|
11277
11362
|
* @param {*} [options] Override http request option.
|
|
@@ -11285,8 +11370,8 @@ export declare const InputProcessorsApiAxiosParamCreator: (configuration?: Confi
|
|
|
11285
11370
|
*/
|
|
11286
11371
|
export declare const InputProcessorsApiFp: (configuration?: Configuration) => {
|
|
11287
11372
|
/**
|
|
11288
|
-
* Returns a list of all available input processors that can be used to transform task inputs.
|
|
11289
|
-
* @summary List
|
|
11373
|
+
* 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
|
|
11374
|
+
* @summary List Input Processors
|
|
11290
11375
|
* @param {string} orgId The unique identifier of the organization.
|
|
11291
11376
|
* @param {string} projectId The unique identifier of the project.
|
|
11292
11377
|
* @param {*} [options] Override http request option.
|
|
@@ -11300,8 +11385,8 @@ export declare const InputProcessorsApiFp: (configuration?: Configuration) => {
|
|
|
11300
11385
|
*/
|
|
11301
11386
|
export declare const InputProcessorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
11302
11387
|
/**
|
|
11303
|
-
* Returns a list of all available input processors that can be used to transform task inputs.
|
|
11304
|
-
* @summary List
|
|
11388
|
+
* 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
|
|
11389
|
+
* @summary List Input Processors
|
|
11305
11390
|
* @param {string} orgId The unique identifier of the organization.
|
|
11306
11391
|
* @param {string} projectId The unique identifier of the project.
|
|
11307
11392
|
* @param {*} [options] Override http request option.
|
|
@@ -11317,8 +11402,8 @@ export declare const InputProcessorsApiFactory: (configuration?: Configuration,
|
|
|
11317
11402
|
*/
|
|
11318
11403
|
export declare class InputProcessorsApi extends BaseAPI {
|
|
11319
11404
|
/**
|
|
11320
|
-
* Returns a list of all available input processors that can be used to transform task inputs.
|
|
11321
|
-
* @summary List
|
|
11405
|
+
* 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
|
|
11406
|
+
* @summary List Input Processors
|
|
11322
11407
|
* @param {string} orgId The unique identifier of the organization.
|
|
11323
11408
|
* @param {string} projectId The unique identifier of the project.
|
|
11324
11409
|
* @param {*} [options] Override http request option.
|
|
@@ -12716,7 +12801,7 @@ export type RemoveModelExclusionFromProjectRuleTypeEnum = typeof RemoveModelExcl
|
|
|
12716
12801
|
*/
|
|
12717
12802
|
export declare const ListingsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12718
12803
|
/**
|
|
12719
|
-
* 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.
|
|
12804
|
+
* 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.
|
|
12720
12805
|
* @summary List Available LLM Models
|
|
12721
12806
|
* @param {string} orgId The unique identifier of the organization.
|
|
12722
12807
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -12736,7 +12821,7 @@ export declare const ListingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
12736
12821
|
*/
|
|
12737
12822
|
getModel: (modelIdOrName: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12738
12823
|
/**
|
|
12739
|
-
* 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.
|
|
12824
|
+
* 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.
|
|
12740
12825
|
* @summary List Available Guardrails
|
|
12741
12826
|
* @param {string} orgId The unique identifier of the organization.
|
|
12742
12827
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -12751,7 +12836,7 @@ export declare const ListingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
12751
12836
|
*/
|
|
12752
12837
|
export declare const ListingsApiFp: (configuration?: Configuration) => {
|
|
12753
12838
|
/**
|
|
12754
|
-
* 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.
|
|
12839
|
+
* 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.
|
|
12755
12840
|
* @summary List Available LLM Models
|
|
12756
12841
|
* @param {string} orgId The unique identifier of the organization.
|
|
12757
12842
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -12771,7 +12856,7 @@ export declare const ListingsApiFp: (configuration?: Configuration) => {
|
|
|
12771
12856
|
*/
|
|
12772
12857
|
getModel(modelIdOrName: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LLMModel>>;
|
|
12773
12858
|
/**
|
|
12774
|
-
* 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.
|
|
12859
|
+
* 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.
|
|
12775
12860
|
* @summary List Available Guardrails
|
|
12776
12861
|
* @param {string} orgId The unique identifier of the organization.
|
|
12777
12862
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -12786,7 +12871,7 @@ export declare const ListingsApiFp: (configuration?: Configuration) => {
|
|
|
12786
12871
|
*/
|
|
12787
12872
|
export declare const ListingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
12788
12873
|
/**
|
|
12789
|
-
* 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.
|
|
12874
|
+
* 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.
|
|
12790
12875
|
* @summary List Available LLM Models
|
|
12791
12876
|
* @param {string} orgId The unique identifier of the organization.
|
|
12792
12877
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -12806,7 +12891,7 @@ export declare const ListingsApiFactory: (configuration?: Configuration, basePat
|
|
|
12806
12891
|
*/
|
|
12807
12892
|
getModel(modelIdOrName: string, orgId: string, projectId: string, options?: any): AxiosPromise<LLMModel>;
|
|
12808
12893
|
/**
|
|
12809
|
-
* 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.
|
|
12894
|
+
* 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.
|
|
12810
12895
|
* @summary List Available Guardrails
|
|
12811
12896
|
* @param {string} orgId The unique identifier of the organization.
|
|
12812
12897
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -12823,7 +12908,7 @@ export declare const ListingsApiFactory: (configuration?: Configuration, basePat
|
|
|
12823
12908
|
*/
|
|
12824
12909
|
export declare class ListingsApi extends BaseAPI {
|
|
12825
12910
|
/**
|
|
12826
|
-
* 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.
|
|
12911
|
+
* 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.
|
|
12827
12912
|
* @summary List Available LLM Models
|
|
12828
12913
|
* @param {string} orgId The unique identifier of the organization.
|
|
12829
12914
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -12845,7 +12930,7 @@ export declare class ListingsApi extends BaseAPI {
|
|
|
12845
12930
|
*/
|
|
12846
12931
|
getModel(modelIdOrName: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LLMModel, any, {}>>;
|
|
12847
12932
|
/**
|
|
12848
|
-
* 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.
|
|
12933
|
+
* 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.
|
|
12849
12934
|
* @summary List Available Guardrails
|
|
12850
12935
|
* @param {string} orgId The unique identifier of the organization.
|
|
12851
12936
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -13549,12 +13634,12 @@ export declare class MCPServersApi extends BaseAPI {
|
|
|
13549
13634
|
updateMcpServer(mcpServerId: string, orgId: string, projectId: string, mcpServerUpdate: McpServerUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<McpServer, any, {}>>;
|
|
13550
13635
|
}
|
|
13551
13636
|
/**
|
|
13552
|
-
*
|
|
13637
|
+
* OAuthClientsApi - axios parameter creator
|
|
13553
13638
|
* @export
|
|
13554
13639
|
*/
|
|
13555
|
-
export declare const
|
|
13640
|
+
export declare const OAuthClientsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13556
13641
|
/**
|
|
13557
|
-
* 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
|
|
13642
|
+
* 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!
|
|
13558
13643
|
* @summary Create OAuth Client
|
|
13559
13644
|
* @param {string} orgId The unique identifier of the organization.
|
|
13560
13645
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -13663,12 +13748,12 @@ export declare const OauthClientsApiAxiosParamCreator: (configuration?: Configur
|
|
|
13663
13748
|
updateOAuthClient: (oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13664
13749
|
};
|
|
13665
13750
|
/**
|
|
13666
|
-
*
|
|
13751
|
+
* OAuthClientsApi - functional programming interface
|
|
13667
13752
|
* @export
|
|
13668
13753
|
*/
|
|
13669
|
-
export declare const
|
|
13754
|
+
export declare const OAuthClientsApiFp: (configuration?: Configuration) => {
|
|
13670
13755
|
/**
|
|
13671
|
-
* 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
|
|
13756
|
+
* 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!
|
|
13672
13757
|
* @summary Create OAuth Client
|
|
13673
13758
|
* @param {string} orgId The unique identifier of the organization.
|
|
13674
13759
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -13777,12 +13862,12 @@ export declare const OauthClientsApiFp: (configuration?: Configuration) => {
|
|
|
13777
13862
|
updateOAuthClient(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OAuthClient>>;
|
|
13778
13863
|
};
|
|
13779
13864
|
/**
|
|
13780
|
-
*
|
|
13865
|
+
* OAuthClientsApi - factory interface
|
|
13781
13866
|
* @export
|
|
13782
13867
|
*/
|
|
13783
|
-
export declare const
|
|
13868
|
+
export declare const OAuthClientsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
13784
13869
|
/**
|
|
13785
|
-
* 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
|
|
13870
|
+
* 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!
|
|
13786
13871
|
* @summary Create OAuth Client
|
|
13787
13872
|
* @param {string} orgId The unique identifier of the organization.
|
|
13788
13873
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -13891,21 +13976,21 @@ export declare const OauthClientsApiFactory: (configuration?: Configuration, bas
|
|
|
13891
13976
|
updateOAuthClient(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: any): AxiosPromise<OAuthClient>;
|
|
13892
13977
|
};
|
|
13893
13978
|
/**
|
|
13894
|
-
*
|
|
13979
|
+
* OAuthClientsApi - object-oriented interface
|
|
13895
13980
|
* @export
|
|
13896
|
-
* @class
|
|
13981
|
+
* @class OAuthClientsApi
|
|
13897
13982
|
* @extends {BaseAPI}
|
|
13898
13983
|
*/
|
|
13899
|
-
export declare class
|
|
13984
|
+
export declare class OAuthClientsApi extends BaseAPI {
|
|
13900
13985
|
/**
|
|
13901
|
-
* 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
|
|
13986
|
+
* 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!
|
|
13902
13987
|
* @summary Create OAuth Client
|
|
13903
13988
|
* @param {string} orgId The unique identifier of the organization.
|
|
13904
13989
|
* @param {string} projectId The unique identifier of the project.
|
|
13905
13990
|
* @param {OAuthClientCreate} oAuthClientCreate
|
|
13906
13991
|
* @param {*} [options] Override http request option.
|
|
13907
13992
|
* @throws {RequiredError}
|
|
13908
|
-
* @memberof
|
|
13993
|
+
* @memberof OAuthClientsApi
|
|
13909
13994
|
*/
|
|
13910
13995
|
createOAuthClient(orgId: string, projectId: string, oAuthClientCreate: OAuthClientCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OAuthClient, any, {}>>;
|
|
13911
13996
|
/**
|
|
@@ -13916,7 +14001,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
13916
14001
|
* @param {string} projectId The unique identifier of the project.
|
|
13917
14002
|
* @param {*} [options] Override http request option.
|
|
13918
14003
|
* @throws {RequiredError}
|
|
13919
|
-
* @memberof
|
|
14004
|
+
* @memberof OAuthClientsApi
|
|
13920
14005
|
*/
|
|
13921
14006
|
deleteOAuthClient(oauthClientId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
13922
14007
|
/**
|
|
@@ -13927,7 +14012,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
13927
14012
|
* @param {string} projectId
|
|
13928
14013
|
* @param {*} [options] Override http request option.
|
|
13929
14014
|
* @throws {RequiredError}
|
|
13930
|
-
* @memberof
|
|
14015
|
+
* @memberof OAuthClientsApi
|
|
13931
14016
|
*/
|
|
13932
14017
|
getOAuthClient(oauthClientId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OAuthClient, any, {}>>;
|
|
13933
14018
|
/**
|
|
@@ -13939,7 +14024,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
13939
14024
|
* @param {string | null} [cursor] A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.
|
|
13940
14025
|
* @param {*} [options] Override http request option.
|
|
13941
14026
|
* @throws {RequiredError}
|
|
13942
|
-
* @memberof
|
|
14027
|
+
* @memberof OAuthClientsApi
|
|
13943
14028
|
*/
|
|
13944
14029
|
listOAuthClients(orgId: string, projectId: string, pageLimit?: number | null, cursor?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedResultSetOAuthClient, any, {}>>;
|
|
13945
14030
|
/**
|
|
@@ -13951,7 +14036,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
13951
14036
|
* @param {string} projectId The project id
|
|
13952
14037
|
* @param {*} [options] Override http request option.
|
|
13953
14038
|
* @throws {RequiredError}
|
|
13954
|
-
* @memberof
|
|
14039
|
+
* @memberof OAuthClientsApi
|
|
13955
14040
|
*/
|
|
13956
14041
|
projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamGetMember(oauthClientId: string, member: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IAMMember, any, {}>>;
|
|
13957
14042
|
/**
|
|
@@ -13963,7 +14048,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
13963
14048
|
* @param {ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum} [type]
|
|
13964
14049
|
* @param {*} [options] Override http request option.
|
|
13965
14050
|
* @throws {RequiredError}
|
|
13966
|
-
* @memberof
|
|
14051
|
+
* @memberof OAuthClientsApi
|
|
13967
14052
|
*/
|
|
13968
14053
|
projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembers(oauthClientId: string, orgId: string, projectId: string, type?: ProjectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamListMembersTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedResultSetIAMMember, any, {}>>;
|
|
13969
14054
|
/**
|
|
@@ -13975,7 +14060,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
13975
14060
|
* @param {BrainApiApiV1IamProjectIAMPermissionTest} brainApiApiV1IamProjectIAMPermissionTest
|
|
13976
14061
|
* @param {*} [options] Override http request option.
|
|
13977
14062
|
* @throws {RequiredError}
|
|
13978
|
-
* @memberof
|
|
14063
|
+
* @memberof OAuthClientsApi
|
|
13979
14064
|
*/
|
|
13980
14065
|
projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamTestPermissions(oauthClientId: string, orgId: string, projectId: string, brainApiApiV1IamProjectIAMPermissionTest: BrainApiApiV1IamProjectIAMPermissionTest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IAMPermissionTest, any, {}>>;
|
|
13981
14066
|
/**
|
|
@@ -13988,7 +14073,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
13988
14073
|
* @param {BrainApiApiV1IamProjectIAMMemberRoleUpdate} brainApiApiV1IamProjectIAMMemberRoleUpdate
|
|
13989
14074
|
* @param {*} [options] Override http request option.
|
|
13990
14075
|
* @throws {RequiredError}
|
|
13991
|
-
* @memberof
|
|
14076
|
+
* @memberof OAuthClientsApi
|
|
13992
14077
|
*/
|
|
13993
14078
|
projectIamOrgOrgIdProjectProjectIdOauthClientOauthClientIdIamUpdateMemberRoles(oauthClientId: string, member: string, orgId: string, projectId: string, brainApiApiV1IamProjectIAMMemberRoleUpdate: BrainApiApiV1IamProjectIAMMemberRoleUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IAMMember, any, {}>>;
|
|
13994
14079
|
/**
|
|
@@ -14000,7 +14085,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
14000
14085
|
* @param {OAuthClientUpdate} oAuthClientUpdate
|
|
14001
14086
|
* @param {*} [options] Override http request option.
|
|
14002
14087
|
* @throws {RequiredError}
|
|
14003
|
-
* @memberof
|
|
14088
|
+
* @memberof OAuthClientsApi
|
|
14004
14089
|
*/
|
|
14005
14090
|
regenerateOAuthClientSecret(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OAuthClientRegenerateSecretResponse, any, {}>>;
|
|
14006
14091
|
/**
|
|
@@ -14012,7 +14097,7 @@ export declare class OauthClientsApi extends BaseAPI {
|
|
|
14012
14097
|
* @param {OAuthClientUpdate} oAuthClientUpdate
|
|
14013
14098
|
* @param {*} [options] Override http request option.
|
|
14014
14099
|
* @throws {RequiredError}
|
|
14015
|
-
* @memberof
|
|
14100
|
+
* @memberof OAuthClientsApi
|
|
14016
14101
|
*/
|
|
14017
14102
|
updateOAuthClient(oauthClientId: string, orgId: string, projectId: string, oAuthClientUpdate: OAuthClientUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OAuthClient, any, {}>>;
|
|
14018
14103
|
}
|
|
@@ -14110,7 +14195,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
14110
14195
|
*/
|
|
14111
14196
|
listOrganizationInvites: (orgId: string, show?: OrgInviteShow, cursor?: string | null, pageLimit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14112
14197
|
/**
|
|
14113
|
-
* List
|
|
14198
|
+
* 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
|
|
14114
14199
|
* @summary List Organizations
|
|
14115
14200
|
* @param {OrgMembership} [membership]
|
|
14116
14201
|
* @param {string | null} [cursor] Pagination cursor for the next page of results
|
|
@@ -14260,7 +14345,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
14260
14345
|
*/
|
|
14261
14346
|
listOrganizationInvites(orgId: string, show?: OrgInviteShow, cursor?: string | null, pageLimit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResultSetOrganizationInvite>>;
|
|
14262
14347
|
/**
|
|
14263
|
-
* List
|
|
14348
|
+
* 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
|
|
14264
14349
|
* @summary List Organizations
|
|
14265
14350
|
* @param {OrgMembership} [membership]
|
|
14266
14351
|
* @param {string | null} [cursor] Pagination cursor for the next page of results
|
|
@@ -14410,7 +14495,7 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
14410
14495
|
*/
|
|
14411
14496
|
listOrganizationInvites(orgId: string, show?: OrgInviteShow, cursor?: string | null, pageLimit?: number, options?: any): AxiosPromise<PaginatedResultSetOrganizationInvite>;
|
|
14412
14497
|
/**
|
|
14413
|
-
* List
|
|
14498
|
+
* 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
|
|
14414
14499
|
* @summary List Organizations
|
|
14415
14500
|
* @param {OrgMembership} [membership]
|
|
14416
14501
|
* @param {string | null} [cursor] Pagination cursor for the next page of results
|
|
@@ -14571,7 +14656,7 @@ export declare class OrganizationsApi extends BaseAPI {
|
|
|
14571
14656
|
*/
|
|
14572
14657
|
listOrganizationInvites(orgId: string, show?: OrgInviteShow, cursor?: string | null, pageLimit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedResultSetOrganizationInvite, any, {}>>;
|
|
14573
14658
|
/**
|
|
14574
|
-
* List
|
|
14659
|
+
* 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
|
|
14575
14660
|
* @summary List Organizations
|
|
14576
14661
|
* @param {OrgMembership} [membership]
|
|
14577
14662
|
* @param {string | null} [cursor] Pagination cursor for the next page of results
|
|
@@ -14666,6 +14751,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
14666
14751
|
* @throws {RequiredError}
|
|
14667
14752
|
*/
|
|
14668
14753
|
createProject: (orgId: string, projectCreate: ProjectCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14754
|
+
/**
|
|
14755
|
+
* 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
|
|
14756
|
+
* @summary Delete Project
|
|
14757
|
+
* @param {string} orgId
|
|
14758
|
+
* @param {string} projectId
|
|
14759
|
+
* @param {*} [options] Override http request option.
|
|
14760
|
+
* @throws {RequiredError}
|
|
14761
|
+
*/
|
|
14762
|
+
deleteProject: (orgId: string, projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14669
14763
|
/**
|
|
14670
14764
|
*
|
|
14671
14765
|
* @summary Get Project
|
|
@@ -14780,6 +14874,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
14780
14874
|
* @throws {RequiredError}
|
|
14781
14875
|
*/
|
|
14782
14876
|
createProject(orgId: string, projectCreate: ProjectCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
14877
|
+
/**
|
|
14878
|
+
* 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
|
|
14879
|
+
* @summary Delete Project
|
|
14880
|
+
* @param {string} orgId
|
|
14881
|
+
* @param {string} projectId
|
|
14882
|
+
* @param {*} [options] Override http request option.
|
|
14883
|
+
* @throws {RequiredError}
|
|
14884
|
+
*/
|
|
14885
|
+
deleteProject(orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
|
|
14783
14886
|
/**
|
|
14784
14887
|
*
|
|
14785
14888
|
* @summary Get Project
|
|
@@ -14894,6 +14997,15 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
14894
14997
|
* @throws {RequiredError}
|
|
14895
14998
|
*/
|
|
14896
14999
|
createProject(orgId: string, projectCreate: ProjectCreate, options?: any): AxiosPromise<Project>;
|
|
15000
|
+
/**
|
|
15001
|
+
* 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
|
|
15002
|
+
* @summary Delete Project
|
|
15003
|
+
* @param {string} orgId
|
|
15004
|
+
* @param {string} projectId
|
|
15005
|
+
* @param {*} [options] Override http request option.
|
|
15006
|
+
* @throws {RequiredError}
|
|
15007
|
+
*/
|
|
15008
|
+
deleteProject(orgId: string, projectId: string, options?: any): AxiosPromise<Project>;
|
|
14897
15009
|
/**
|
|
14898
15010
|
*
|
|
14899
15011
|
* @summary Get Project
|
|
@@ -15011,6 +15123,16 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
15011
15123
|
* @memberof ProjectsApi
|
|
15012
15124
|
*/
|
|
15013
15125
|
createProject(orgId: string, projectCreate: ProjectCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any, {}>>;
|
|
15126
|
+
/**
|
|
15127
|
+
* 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
|
|
15128
|
+
* @summary Delete Project
|
|
15129
|
+
* @param {string} orgId
|
|
15130
|
+
* @param {string} projectId
|
|
15131
|
+
* @param {*} [options] Override http request option.
|
|
15132
|
+
* @throws {RequiredError}
|
|
15133
|
+
* @memberof ProjectsApi
|
|
15134
|
+
*/
|
|
15135
|
+
deleteProject(orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any, {}>>;
|
|
15014
15136
|
/**
|
|
15015
15137
|
*
|
|
15016
15138
|
* @summary Get Project
|
|
@@ -16021,15 +16143,15 @@ export type UpdateTagEntityTypeEnum = typeof UpdateTagEntityTypeEnum[keyof typeo
|
|
|
16021
16143
|
*/
|
|
16022
16144
|
export declare const TaskForwardersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16023
16145
|
/**
|
|
16024
|
-
* Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete -
|
|
16146
|
+
* 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.
|
|
16025
16147
|
* @summary Create Task Forwarder
|
|
16026
16148
|
* @param {string} orgId The unique identifier of the organization.
|
|
16027
16149
|
* @param {string} projectId The unique identifier of the project.
|
|
16028
|
-
* @param {
|
|
16150
|
+
* @param {TaskForwarder} taskForwarder
|
|
16029
16151
|
* @param {*} [options] Override http request option.
|
|
16030
16152
|
* @throws {RequiredError}
|
|
16031
16153
|
*/
|
|
16032
|
-
createTaskForwarder: (orgId: string, projectId: string,
|
|
16154
|
+
createTaskForwarder: (orgId: string, projectId: string, taskForwarder: TaskForwarder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16033
16155
|
/**
|
|
16034
16156
|
*
|
|
16035
16157
|
* @summary Get Task Forwarder
|
|
@@ -16041,7 +16163,7 @@ export declare const TaskForwardersApiAxiosParamCreator: (configuration?: Config
|
|
|
16041
16163
|
*/
|
|
16042
16164
|
getTaskForwarder: (taskForwarderId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16043
16165
|
/**
|
|
16044
|
-
* 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.
|
|
16166
|
+
* 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.
|
|
16045
16167
|
* @summary List Task Forwarder Types
|
|
16046
16168
|
* @param {string} orgId The unique identifier of the organization.
|
|
16047
16169
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16111,11 +16233,11 @@ export declare const TaskForwardersApiAxiosParamCreator: (configuration?: Config
|
|
|
16111
16233
|
* @param {string} taskForwarderId The specific Task to reference.
|
|
16112
16234
|
* @param {string} orgId The unique identifier of the organization.
|
|
16113
16235
|
* @param {string} projectId The unique identifier of the project.
|
|
16114
|
-
* @param {
|
|
16236
|
+
* @param {TaskForwarder1} taskForwarder1
|
|
16115
16237
|
* @param {*} [options] Override http request option.
|
|
16116
16238
|
* @throws {RequiredError}
|
|
16117
16239
|
*/
|
|
16118
|
-
updateTaskForwarder: (taskForwarderId: string, orgId: string, projectId: string,
|
|
16240
|
+
updateTaskForwarder: (taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16119
16241
|
};
|
|
16120
16242
|
/**
|
|
16121
16243
|
* TaskForwardersApi - functional programming interface
|
|
@@ -16123,15 +16245,15 @@ export declare const TaskForwardersApiAxiosParamCreator: (configuration?: Config
|
|
|
16123
16245
|
*/
|
|
16124
16246
|
export declare const TaskForwardersApiFp: (configuration?: Configuration) => {
|
|
16125
16247
|
/**
|
|
16126
|
-
* Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete -
|
|
16248
|
+
* 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.
|
|
16127
16249
|
* @summary Create Task Forwarder
|
|
16128
16250
|
* @param {string} orgId The unique identifier of the organization.
|
|
16129
16251
|
* @param {string} projectId The unique identifier of the project.
|
|
16130
|
-
* @param {
|
|
16252
|
+
* @param {TaskForwarder} taskForwarder
|
|
16131
16253
|
* @param {*} [options] Override http request option.
|
|
16132
16254
|
* @throws {RequiredError}
|
|
16133
16255
|
*/
|
|
16134
|
-
createTaskForwarder(orgId: string, projectId: string,
|
|
16256
|
+
createTaskForwarder(orgId: string, projectId: string, taskForwarder: TaskForwarder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseCreatetaskforwarder>>;
|
|
16135
16257
|
/**
|
|
16136
16258
|
*
|
|
16137
16259
|
* @summary Get Task Forwarder
|
|
@@ -16143,7 +16265,7 @@ export declare const TaskForwardersApiFp: (configuration?: Configuration) => {
|
|
|
16143
16265
|
*/
|
|
16144
16266
|
getTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseGettaskforwarder>>;
|
|
16145
16267
|
/**
|
|
16146
|
-
* 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.
|
|
16268
|
+
* 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.
|
|
16147
16269
|
* @summary List Task Forwarder Types
|
|
16148
16270
|
* @param {string} orgId The unique identifier of the organization.
|
|
16149
16271
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16213,11 +16335,11 @@ export declare const TaskForwardersApiFp: (configuration?: Configuration) => {
|
|
|
16213
16335
|
* @param {string} taskForwarderId The specific Task to reference.
|
|
16214
16336
|
* @param {string} orgId The unique identifier of the organization.
|
|
16215
16337
|
* @param {string} projectId The unique identifier of the project.
|
|
16216
|
-
* @param {
|
|
16338
|
+
* @param {TaskForwarder1} taskForwarder1
|
|
16217
16339
|
* @param {*} [options] Override http request option.
|
|
16218
16340
|
* @throws {RequiredError}
|
|
16219
16341
|
*/
|
|
16220
|
-
updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string,
|
|
16342
|
+
updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseUpdatetaskforwarder>>;
|
|
16221
16343
|
};
|
|
16222
16344
|
/**
|
|
16223
16345
|
* TaskForwardersApi - factory interface
|
|
@@ -16225,15 +16347,15 @@ export declare const TaskForwardersApiFp: (configuration?: Configuration) => {
|
|
|
16225
16347
|
*/
|
|
16226
16348
|
export declare const TaskForwardersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16227
16349
|
/**
|
|
16228
|
-
* Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete -
|
|
16350
|
+
* 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.
|
|
16229
16351
|
* @summary Create Task Forwarder
|
|
16230
16352
|
* @param {string} orgId The unique identifier of the organization.
|
|
16231
16353
|
* @param {string} projectId The unique identifier of the project.
|
|
16232
|
-
* @param {
|
|
16354
|
+
* @param {TaskForwarder} taskForwarder
|
|
16233
16355
|
* @param {*} [options] Override http request option.
|
|
16234
16356
|
* @throws {RequiredError}
|
|
16235
16357
|
*/
|
|
16236
|
-
createTaskForwarder(orgId: string, projectId: string,
|
|
16358
|
+
createTaskForwarder(orgId: string, projectId: string, taskForwarder: TaskForwarder, options?: any): AxiosPromise<ResponseCreatetaskforwarder>;
|
|
16237
16359
|
/**
|
|
16238
16360
|
*
|
|
16239
16361
|
* @summary Get Task Forwarder
|
|
@@ -16245,7 +16367,7 @@ export declare const TaskForwardersApiFactory: (configuration?: Configuration, b
|
|
|
16245
16367
|
*/
|
|
16246
16368
|
getTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, options?: any): AxiosPromise<ResponseGettaskforwarder>;
|
|
16247
16369
|
/**
|
|
16248
|
-
* 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.
|
|
16370
|
+
* 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.
|
|
16249
16371
|
* @summary List Task Forwarder Types
|
|
16250
16372
|
* @param {string} orgId The unique identifier of the organization.
|
|
16251
16373
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16315,11 +16437,11 @@ export declare const TaskForwardersApiFactory: (configuration?: Configuration, b
|
|
|
16315
16437
|
* @param {string} taskForwarderId The specific Task to reference.
|
|
16316
16438
|
* @param {string} orgId The unique identifier of the organization.
|
|
16317
16439
|
* @param {string} projectId The unique identifier of the project.
|
|
16318
|
-
* @param {
|
|
16440
|
+
* @param {TaskForwarder1} taskForwarder1
|
|
16319
16441
|
* @param {*} [options] Override http request option.
|
|
16320
16442
|
* @throws {RequiredError}
|
|
16321
16443
|
*/
|
|
16322
|
-
updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string,
|
|
16444
|
+
updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options?: any): AxiosPromise<ResponseUpdatetaskforwarder>;
|
|
16323
16445
|
};
|
|
16324
16446
|
/**
|
|
16325
16447
|
* TaskForwardersApi - object-oriented interface
|
|
@@ -16329,16 +16451,16 @@ export declare const TaskForwardersApiFactory: (configuration?: Configuration, b
|
|
|
16329
16451
|
*/
|
|
16330
16452
|
export declare class TaskForwardersApi extends BaseAPI {
|
|
16331
16453
|
/**
|
|
16332
|
-
* Create a new task forwarder to automatically route task outputs. Task forwarders enable: - Webhook notifications when tasks complete -
|
|
16454
|
+
* 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.
|
|
16333
16455
|
* @summary Create Task Forwarder
|
|
16334
16456
|
* @param {string} orgId The unique identifier of the organization.
|
|
16335
16457
|
* @param {string} projectId The unique identifier of the project.
|
|
16336
|
-
* @param {
|
|
16458
|
+
* @param {TaskForwarder} taskForwarder
|
|
16337
16459
|
* @param {*} [options] Override http request option.
|
|
16338
16460
|
* @throws {RequiredError}
|
|
16339
16461
|
* @memberof TaskForwardersApi
|
|
16340
16462
|
*/
|
|
16341
|
-
createTaskForwarder(orgId: string, projectId: string,
|
|
16463
|
+
createTaskForwarder(orgId: string, projectId: string, taskForwarder: TaskForwarder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseCreatetaskforwarder, any, {}>>;
|
|
16342
16464
|
/**
|
|
16343
16465
|
*
|
|
16344
16466
|
* @summary Get Task Forwarder
|
|
@@ -16351,7 +16473,7 @@ export declare class TaskForwardersApi extends BaseAPI {
|
|
|
16351
16473
|
*/
|
|
16352
16474
|
getTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseGettaskforwarder, any, {}>>;
|
|
16353
16475
|
/**
|
|
16354
|
-
* 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.
|
|
16476
|
+
* 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.
|
|
16355
16477
|
* @summary List Task Forwarder Types
|
|
16356
16478
|
* @param {string} orgId The unique identifier of the organization.
|
|
16357
16479
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16427,12 +16549,12 @@ export declare class TaskForwardersApi extends BaseAPI {
|
|
|
16427
16549
|
* @param {string} taskForwarderId The specific Task to reference.
|
|
16428
16550
|
* @param {string} orgId The unique identifier of the organization.
|
|
16429
16551
|
* @param {string} projectId The unique identifier of the project.
|
|
16430
|
-
* @param {
|
|
16552
|
+
* @param {TaskForwarder1} taskForwarder1
|
|
16431
16553
|
* @param {*} [options] Override http request option.
|
|
16432
16554
|
* @throws {RequiredError}
|
|
16433
16555
|
* @memberof TaskForwardersApi
|
|
16434
16556
|
*/
|
|
16435
|
-
updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string,
|
|
16557
|
+
updateTaskForwarder(taskForwarderId: string, orgId: string, projectId: string, taskForwarder1: TaskForwarder1, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseUpdatetaskforwarder, any, {}>>;
|
|
16436
16558
|
}
|
|
16437
16559
|
/**
|
|
16438
16560
|
* @export
|
|
@@ -16459,7 +16581,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16459
16581
|
*/
|
|
16460
16582
|
cloneSharedTask: (shortId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16461
16583
|
/**
|
|
16462
|
-
* 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
|
|
16584
|
+
* 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.
|
|
16463
16585
|
* @summary Create a New Task
|
|
16464
16586
|
* @param {string} orgId The unique identifier of the organization.
|
|
16465
16587
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16543,7 +16665,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16543
16665
|
*/
|
|
16544
16666
|
getTaskCreditReport: (orgId: string, projectId: string, taskId: string, startDate?: string | null, endDate?: string | null, showReportingGroup?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16545
16667
|
/**
|
|
16546
|
-
* 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
|
|
16668
|
+
* 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
|
|
16547
16669
|
* @summary Fetch a Task Run
|
|
16548
16670
|
* @param {string} orgId The unique identifier of the organization.
|
|
16549
16671
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16554,7 +16676,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16554
16676
|
*/
|
|
16555
16677
|
getTaskRun: (orgId: string, projectId: string, taskId: string, taskRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16556
16678
|
/**
|
|
16557
|
-
* Fetch an individual Task Run file.
|
|
16679
|
+
* 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.
|
|
16558
16680
|
* @summary Fetch a user submitted file (image or audio) for a given Task Run
|
|
16559
16681
|
* @param {string} orgId The unique identifier of the organization.
|
|
16560
16682
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16619,7 +16741,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16619
16741
|
*/
|
|
16620
16742
|
getTaskUsageReport: (orgId: string, projectId: string, taskId: string, aggregation?: GetTaskUsageReportAggregationEnum, errorsOnly?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16621
16743
|
/**
|
|
16622
|
-
* 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.
|
|
16744
|
+
* 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.
|
|
16623
16745
|
* @summary List Task Shares
|
|
16624
16746
|
* @param {string} orgId The unique identifier of the organization.
|
|
16625
16747
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16654,11 +16776,12 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16654
16776
|
*/
|
|
16655
16777
|
revokeTaskShare: (orgId: string, projectId: string, taskId: string, shareId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16656
16778
|
/**
|
|
16657
|
-
* 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
|
|
16779
|
+
* 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.
|
|
16658
16780
|
* @summary Run Task
|
|
16659
16781
|
* @param {string} orgId The unique identifier of the organization.
|
|
16660
16782
|
* @param {string} projectId The unique identifier of the project.
|
|
16661
16783
|
* @param {string} taskId The specific Task to reference.
|
|
16784
|
+
* @param {RunTaskRequest} runTaskRequest
|
|
16662
16785
|
* @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.
|
|
16663
16786
|
* @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.
|
|
16664
16787
|
* @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
|
|
@@ -16666,7 +16789,7 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
16666
16789
|
* @param {*} [options] Override http request option.
|
|
16667
16790
|
* @throws {RequiredError}
|
|
16668
16791
|
*/
|
|
16669
|
-
runTask: (orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16792
|
+
runTask: (orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16670
16793
|
/**
|
|
16671
16794
|
* Retrieve a specific member that has been granted direct access to the task.
|
|
16672
16795
|
* @summary IAM - Lookup Task Member
|
|
@@ -16740,7 +16863,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
16740
16863
|
*/
|
|
16741
16864
|
cloneSharedTask(shortId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>>;
|
|
16742
16865
|
/**
|
|
16743
|
-
* 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
|
|
16866
|
+
* 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.
|
|
16744
16867
|
* @summary Create a New Task
|
|
16745
16868
|
* @param {string} orgId The unique identifier of the organization.
|
|
16746
16869
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16824,7 +16947,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
16824
16947
|
*/
|
|
16825
16948
|
getTaskCreditReport(orgId: string, projectId: string, taskId: string, startDate?: string | null, endDate?: string | null, showReportingGroup?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRunCreditReport>>;
|
|
16826
16949
|
/**
|
|
16827
|
-
* 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
|
|
16950
|
+
* 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
|
|
16828
16951
|
* @summary Fetch a Task Run
|
|
16829
16952
|
* @param {string} orgId The unique identifier of the organization.
|
|
16830
16953
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16835,7 +16958,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
16835
16958
|
*/
|
|
16836
16959
|
getTaskRun(orgId: string, projectId: string, taskId: string, taskRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRun>>;
|
|
16837
16960
|
/**
|
|
16838
|
-
* Fetch an individual Task Run file.
|
|
16961
|
+
* 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.
|
|
16839
16962
|
* @summary Fetch a user submitted file (image or audio) for a given Task Run
|
|
16840
16963
|
* @param {string} orgId The unique identifier of the organization.
|
|
16841
16964
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16846,7 +16969,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
16846
16969
|
* @param {*} [options] Override http request option.
|
|
16847
16970
|
* @throws {RequiredError}
|
|
16848
16971
|
*/
|
|
16849
|
-
getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
16972
|
+
getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
16850
16973
|
/**
|
|
16851
16974
|
* Retrieve a paginated list of task runs for a specific task. Task runs provide an audit trail of all task executions, including: - Input parameters used - Execution status and timing - Resource usage metrics (tokens, credits) - Output results - Error information for failed runs - Fallback model usage information This endpoint supports: - Pagination using cursor-based navigation - Filtering by task revision - Sorting by creation time (newest first) Common use cases: 1. Monitoring task execution history 2. Auditing task usage and performance 3. Debugging task behavior across multiple runs 4. Analyzing task output patterns 5. Tracking fallback model usage and reliability
|
|
16852
16975
|
* @summary List Task Runs
|
|
@@ -16900,7 +17023,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
16900
17023
|
*/
|
|
16901
17024
|
getTaskUsageReport(orgId: string, projectId: string, taskId: string, aggregation?: GetTaskUsageReportAggregationEnum, errorsOnly?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRunUsageReport>>;
|
|
16902
17025
|
/**
|
|
16903
|
-
* 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.
|
|
17026
|
+
* 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.
|
|
16904
17027
|
* @summary List Task Shares
|
|
16905
17028
|
* @param {string} orgId The unique identifier of the organization.
|
|
16906
17029
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -16935,11 +17058,12 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
16935
17058
|
*/
|
|
16936
17059
|
revokeTaskShare(orgId: string, projectId: string, taskId: string, shareId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskShare>>;
|
|
16937
17060
|
/**
|
|
16938
|
-
* 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
|
|
17061
|
+
* 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.
|
|
16939
17062
|
* @summary Run Task
|
|
16940
17063
|
* @param {string} orgId The unique identifier of the organization.
|
|
16941
17064
|
* @param {string} projectId The unique identifier of the project.
|
|
16942
17065
|
* @param {string} taskId The specific Task to reference.
|
|
17066
|
+
* @param {RunTaskRequest} runTaskRequest
|
|
16943
17067
|
* @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.
|
|
16944
17068
|
* @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.
|
|
16945
17069
|
* @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
|
|
@@ -16947,7 +17071,7 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
16947
17071
|
* @param {*} [options] Override http request option.
|
|
16948
17072
|
* @throws {RequiredError}
|
|
16949
17073
|
*/
|
|
16950
|
-
runTask(orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRun>>;
|
|
17074
|
+
runTask(orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRun>>;
|
|
16951
17075
|
/**
|
|
16952
17076
|
* Retrieve a specific member that has been granted direct access to the task.
|
|
16953
17077
|
* @summary IAM - Lookup Task Member
|
|
@@ -17021,7 +17145,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17021
17145
|
*/
|
|
17022
17146
|
cloneSharedTask(shortId: string, orgId: string, projectId: string, options?: any): AxiosPromise<Task>;
|
|
17023
17147
|
/**
|
|
17024
|
-
* 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
|
|
17148
|
+
* 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.
|
|
17025
17149
|
* @summary Create a New Task
|
|
17026
17150
|
* @param {string} orgId The unique identifier of the organization.
|
|
17027
17151
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17105,7 +17229,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17105
17229
|
*/
|
|
17106
17230
|
getTaskCreditReport(orgId: string, projectId: string, taskId: string, startDate?: string | null, endDate?: string | null, showReportingGroup?: boolean, options?: any): AxiosPromise<TaskRunCreditReport>;
|
|
17107
17231
|
/**
|
|
17108
|
-
* 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
|
|
17232
|
+
* 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
|
|
17109
17233
|
* @summary Fetch a Task Run
|
|
17110
17234
|
* @param {string} orgId The unique identifier of the organization.
|
|
17111
17235
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17116,7 +17240,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17116
17240
|
*/
|
|
17117
17241
|
getTaskRun(orgId: string, projectId: string, taskId: string, taskRunId: string, options?: any): AxiosPromise<TaskRun>;
|
|
17118
17242
|
/**
|
|
17119
|
-
* Fetch an individual Task Run file.
|
|
17243
|
+
* 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.
|
|
17120
17244
|
* @summary Fetch a user submitted file (image or audio) for a given Task Run
|
|
17121
17245
|
* @param {string} orgId The unique identifier of the organization.
|
|
17122
17246
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17127,7 +17251,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17127
17251
|
* @param {*} [options] Override http request option.
|
|
17128
17252
|
* @throws {RequiredError}
|
|
17129
17253
|
*/
|
|
17130
|
-
getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: any): AxiosPromise<
|
|
17254
|
+
getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: any): AxiosPromise<any>;
|
|
17131
17255
|
/**
|
|
17132
17256
|
* Retrieve a paginated list of task runs for a specific task. Task runs provide an audit trail of all task executions, including: - Input parameters used - Execution status and timing - Resource usage metrics (tokens, credits) - Output results - Error information for failed runs - Fallback model usage information This endpoint supports: - Pagination using cursor-based navigation - Filtering by task revision - Sorting by creation time (newest first) Common use cases: 1. Monitoring task execution history 2. Auditing task usage and performance 3. Debugging task behavior across multiple runs 4. Analyzing task output patterns 5. Tracking fallback model usage and reliability
|
|
17133
17257
|
* @summary List Task Runs
|
|
@@ -17181,7 +17305,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17181
17305
|
*/
|
|
17182
17306
|
getTaskUsageReport(orgId: string, projectId: string, taskId: string, aggregation?: GetTaskUsageReportAggregationEnum, errorsOnly?: boolean, options?: any): AxiosPromise<TaskRunUsageReport>;
|
|
17183
17307
|
/**
|
|
17184
|
-
* 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.
|
|
17308
|
+
* 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.
|
|
17185
17309
|
* @summary List Task Shares
|
|
17186
17310
|
* @param {string} orgId The unique identifier of the organization.
|
|
17187
17311
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17216,11 +17340,12 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17216
17340
|
*/
|
|
17217
17341
|
revokeTaskShare(orgId: string, projectId: string, taskId: string, shareId: string, options?: any): AxiosPromise<TaskShare>;
|
|
17218
17342
|
/**
|
|
17219
|
-
* 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
|
|
17343
|
+
* 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.
|
|
17220
17344
|
* @summary Run Task
|
|
17221
17345
|
* @param {string} orgId The unique identifier of the organization.
|
|
17222
17346
|
* @param {string} projectId The unique identifier of the project.
|
|
17223
17347
|
* @param {string} taskId The specific Task to reference.
|
|
17348
|
+
* @param {RunTaskRequest} runTaskRequest
|
|
17224
17349
|
* @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.
|
|
17225
17350
|
* @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.
|
|
17226
17351
|
* @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
|
|
@@ -17228,7 +17353,7 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
17228
17353
|
* @param {*} [options] Override http request option.
|
|
17229
17354
|
* @throws {RequiredError}
|
|
17230
17355
|
*/
|
|
17231
|
-
runTask(orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: any): AxiosPromise<TaskRun>;
|
|
17356
|
+
runTask(orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: any): AxiosPromise<TaskRun>;
|
|
17232
17357
|
/**
|
|
17233
17358
|
* Retrieve a specific member that has been granted direct access to the task.
|
|
17234
17359
|
* @summary IAM - Lookup Task Member
|
|
@@ -17305,7 +17430,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
17305
17430
|
*/
|
|
17306
17431
|
cloneSharedTask(shortId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any, {}>>;
|
|
17307
17432
|
/**
|
|
17308
|
-
* 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
|
|
17433
|
+
* 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.
|
|
17309
17434
|
* @summary Create a New Task
|
|
17310
17435
|
* @param {string} orgId The unique identifier of the organization.
|
|
17311
17436
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17397,7 +17522,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
17397
17522
|
*/
|
|
17398
17523
|
getTaskCreditReport(orgId: string, projectId: string, taskId: string, startDate?: string | null, endDate?: string | null, showReportingGroup?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskRunCreditReport, any, {}>>;
|
|
17399
17524
|
/**
|
|
17400
|
-
* 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
|
|
17525
|
+
* 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
|
|
17401
17526
|
* @summary Fetch a Task Run
|
|
17402
17527
|
* @param {string} orgId The unique identifier of the organization.
|
|
17403
17528
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17409,7 +17534,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
17409
17534
|
*/
|
|
17410
17535
|
getTaskRun(orgId: string, projectId: string, taskId: string, taskRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskRun, any, {}>>;
|
|
17411
17536
|
/**
|
|
17412
|
-
* Fetch an individual Task Run file.
|
|
17537
|
+
* 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.
|
|
17413
17538
|
* @summary Fetch a user submitted file (image or audio) for a given Task Run
|
|
17414
17539
|
* @param {string} orgId The unique identifier of the organization.
|
|
17415
17540
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17421,7 +17546,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
17421
17546
|
* @throws {RequiredError}
|
|
17422
17547
|
* @memberof TasksApi
|
|
17423
17548
|
*/
|
|
17424
|
-
getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
17549
|
+
getTaskRunFile(orgId: string, projectId: string, taskId: string, taskRunId: string, fileName: string, inline?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
17425
17550
|
/**
|
|
17426
17551
|
* Retrieve a paginated list of task runs for a specific task. Task runs provide an audit trail of all task executions, including: - Input parameters used - Execution status and timing - Resource usage metrics (tokens, credits) - Output results - Error information for failed runs - Fallback model usage information This endpoint supports: - Pagination using cursor-based navigation - Filtering by task revision - Sorting by creation time (newest first) Common use cases: 1. Monitoring task execution history 2. Auditing task usage and performance 3. Debugging task behavior across multiple runs 4. Analyzing task output patterns 5. Tracking fallback model usage and reliability
|
|
17427
17552
|
* @summary List Task Runs
|
|
@@ -17479,7 +17604,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
17479
17604
|
*/
|
|
17480
17605
|
getTaskUsageReport(orgId: string, projectId: string, taskId: string, aggregation?: GetTaskUsageReportAggregationEnum, errorsOnly?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskRunUsageReport, any, {}>>;
|
|
17481
17606
|
/**
|
|
17482
|
-
* 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.
|
|
17607
|
+
* 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.
|
|
17483
17608
|
* @summary List Task Shares
|
|
17484
17609
|
* @param {string} orgId The unique identifier of the organization.
|
|
17485
17610
|
* @param {string} projectId The unique identifier of the project.
|
|
@@ -17517,11 +17642,12 @@ export declare class TasksApi extends BaseAPI {
|
|
|
17517
17642
|
*/
|
|
17518
17643
|
revokeTaskShare(orgId: string, projectId: string, taskId: string, shareId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskShare, any, {}>>;
|
|
17519
17644
|
/**
|
|
17520
|
-
* 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
|
|
17645
|
+
* 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.
|
|
17521
17646
|
* @summary Run Task
|
|
17522
17647
|
* @param {string} orgId The unique identifier of the organization.
|
|
17523
17648
|
* @param {string} projectId The unique identifier of the project.
|
|
17524
17649
|
* @param {string} taskId The specific Task to reference.
|
|
17650
|
+
* @param {RunTaskRequest} runTaskRequest
|
|
17525
17651
|
* @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.
|
|
17526
17652
|
* @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.
|
|
17527
17653
|
* @param {string | null} [reportingGroup] Optional reporting group name to associate with this task run
|
|
@@ -17530,7 +17656,7 @@ export declare class TasksApi extends BaseAPI {
|
|
|
17530
17656
|
* @throws {RequiredError}
|
|
17531
17657
|
* @memberof TasksApi
|
|
17532
17658
|
*/
|
|
17533
|
-
runTask(orgId: string, projectId: string, taskId: string, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskRun, any, {}>>;
|
|
17659
|
+
runTask(orgId: string, projectId: string, taskId: string, runTaskRequest: RunTaskRequest, revisionId?: string | null, revisionTag?: string | null, reportingGroup?: string | null, useFallbackModel?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskRun, any, {}>>;
|
|
17534
17660
|
/**
|
|
17535
17661
|
* Retrieve a specific member that has been granted direct access to the task.
|
|
17536
17662
|
* @summary IAM - Lookup Task Member
|