Skip to main content
POST
/
v1
/
batch-jobs
Create a new batch job
curl --request POST \
  --url https://gateway.app.clavata.ai:8443/v1/batch-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "policyId": "<string>",
  "webhookUrl": "<string>"
}
'
{
  "batchJobId": "<string>",
  "name": "<string>",
  "error": {
    "errorCode": "BATCH_JOB_ERROR_UNSPECIFIED",
    "errorMessage": "<string>"
  },
  "inputFileUploadUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
​
policyId
string
​
webhookUrl
string

The webhook URL to call when the batch job is complete. Optional.

Response

A successful response.

​
batchJobId
string
​
name
string
​
error
object
​
inputFileUploadUrl
string