Create views batch job

POST

https://api.hi.umnai.com/views-batch-jobs

POST

/views-batch-jobs

$ curl -X POST https://api.hi.umnai.com/views-batch-jobs \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Sample Views Batch Job",
>   "views_batch_configuration_id": "9c3ff42a41d026dee0d885357a576747",
>   "model_id": "20f35e630daf44dbfa4c3f68f5399d8c",
>   "views_batches": [
>     {
>       "type": "MINI_BATCH",
>       "name": "Sample Views Batche",
>       "queries": {},
>       "targets": {}
>     }
>   ],
>   "compute_configuration_id": "351df95006b1350e597762a1d58e9319",
>   "maximum_runtime_seconds": 3600
> }'

1 {
2   "id": "483be50d0ddd306d15dd0cd4896e7715",
3   "name": "Sample Views Batch Job",
4   "account": {
5     "id": "e268443e43d93dab7ebef303bbe9642f",
6     "name": "Sample Account"
7   },
8   "views_batch_configuration": {
9     "id": "9c3ff42a41d026dee0d885357a576747",
10     "name": "Sample Views Batch Configuration"
11   },
12   "status": "STARTING",
13   "created_at": "2026-03-15T10:15:30.000000Z",
14   "model": {
15     "id": "20f35e630daf44dbfa4c3f68f5399d8c",
16     "name": "Sample Model"
17   },
18   "workspace": {
19     "id": "1629dee48cc4e53161f9b2be8614e062",
20     "name": "Sample Workspace"
21   },
22   "compute_configuration": {
23     "id": "351df95006b1350e597762a1d58e9319",
24     "name": "Sample Compute Configuration"
25   },
26   "maximum_runtime_seconds": 1,
27   "stage": "sample_stage",
28   "progress": 0.5,
29   "created_by": {
30     "id": "dad46b2058752ffde5eaf02f1eb6abd5",
31     "name": "Sample User"
32   },
33   "updated_at": "2026-03-15T10:15:30.000000Z",
34   "views_batches": [
35     {
36       "id": "52eab2b319178fc157009bfae5b9c3ca",
37       "name": "Sample Views Batche"
38     }
39   ]
40 }

Create a new views batch job.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Details of the views batch job to create.

namestringRequired3-50 characters

Name of the batch job.

views_batch_configuration_idstringRequired

Unique ID of the views batch configuration to use for the job.

model_idstringRequired

Unique ID of the model to use for the views batch job.

views_batcheslist of objectsRequired

List of views batches to process in the views batch job.

compute_configuration_idstringOptional

ID of the compute configuration.

maximum_runtime_secondsintegerOptional>=1Defaults to 3600

Specifies the maximum allowed runtime, in seconds, for the views batch job.

Response

Views batch job successfully created.

idstring

Unique ID of the batch job.

namestring3-50 characters

Name of the batch job.

accountobject

views_batch_configurationobject

statusenum

created_atdatetime

Timestamp when the batch job was created.

modelobject

workspaceobject

compute_configurationobject

maximum_runtime_secondsinteger>=1

Specifies the maximum allowed runtime, in seconds, for the training job.

stagestring

The current stage of the job.

progressdouble

The overall progress of the job.

created_byobject or null

Reference of the user who created the batch job, if known.

updated_atdatetime

Timestamp when the batch job was last updated.

views_batcheslist of objects

List of views batches associated with the views batch job.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error