Skip to main content
GET
/
v1
/
jobs
List jobs
curl --request GET \
  --url https://gateway.app.clavata.ai:8443/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "jobs": [
    {
      "jobUuid": "<string>",
      "customerId": "<string>",
      "status": "JOB_STATUS_UNSPECIFIED",
      "contentData": [
        {
          "contentHash": "<string>",
          "metadata": {}
        }
      ],
      "results": [
        {
          "jobUuid": "<string>",
          "report": {
            "policyId": "<string>",
            "policyKey": "<string>",
            "policyVersionId": "<string>",
            "result": "OUTCOME_UNSPECIFIED",
            "sectionEvaluationReports": [
              {
                "name": "<string>",
                "result": "OUTCOME_UNSPECIFIED",
                "message": "<string>",
                "assertionEvaluationReports": [
                  {
                    "result": "OUTCOME_UNSPECIFIED",
                    "message": "<string>",
                    "score": 123
                  }
                ],
                "exceptionEvaluationReport": {
                  "result": "OUTCOME_UNSPECIFIED",
                  "assertionEvaluationReports": [
                    {
                      "result": "OUTCOME_UNSPECIFIED",
                      "message": "<string>",
                      "score": 123
                    }
                  ],
                  "reviewResult": {
                    "outcome": "OUTCOME_UNSPECIFIED",
                    "score": 123
                  }
                },
                "reviewResult": {
                  "outcome": "OUTCOME_UNSPECIFIED",
                  "score": 123
                }
              }
            ],
            "exceptionEvaluationReport": {
              "result": "OUTCOME_UNSPECIFIED",
              "assertionEvaluationReports": [
                {
                  "result": "OUTCOME_UNSPECIFIED",
                  "message": "<string>",
                  "score": 123
                }
              ],
              "reviewResult": {
                "outcome": "OUTCOME_UNSPECIFIED",
                "score": 123
              }
            },
            "contentHash": "<string>",
            "contentMetadata": {},
            "reviewResult": {
              "outcome": "OUTCOME_UNSPECIFIED",
              "score": 123
            },
            "threshold": 123,
            "labelMatches": {},
            "tokenUsage": {
              "inputTokens": 123,
              "billedTokens": 123,
              "multiplier": 123
            }
          },
          "created": "2023-11-07T05:31:56Z"
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "completed": "2023-11-07T05:31:56Z",
      "policyId": "<string>",
      "policyVersionId": "<string>",
      "threshold": 123
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
query.createdTimeRange.start
string<date-time>

The start of the time range

​
query.createdTimeRange.end
string<date-time>

The end of the time range

​
query.createdTimeRange.inclusive
boolean

Whether to treat the time range as inclusive or exclusive

​
query.updatedTimeRange.start
string<date-time>

The start of the time range

​
query.updatedTimeRange.end
string<date-time>

The end of the time range

​
query.updatedTimeRange.inclusive
boolean

Whether to treat the time range as inclusive or exclusive

​
query.completedTimeRange.start
string<date-time>

The start of the time range

​
query.completedTimeRange.end
string<date-time>

The end of the time range

​
query.completedTimeRange.inclusive
boolean

Whether to treat the time range as inclusive or exclusive

​
query.status
enum<string>
default:JOB_STATUS_UNSPECIFIED

The status of the job

Available options:
JOB_STATUS_UNSPECIFIED,
JOB_STATUS_PENDING,
JOB_STATUS_RUNNING,
JOB_STATUS_COMPLETED,
JOB_STATUS_FAILED,
JOB_STATUS_CANCELED
​
query.policyId
string

Policy ID that created the job

​
pageSize
integer<int32>

The maximum number of jobs to return. Defaults to 10, capped at 1000.

​
pageToken
string

A token identifying the page to return; for keyset pagination

Response

A successful response.

​
jobs
Job · object[]
​
nextPageToken
string