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>"
}Retrieves a list of jobs with optional filtering by time ranges and status. Incomplete jobs will only include basic information.
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>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The start of the time range
The end of the time range
Whether to treat the time range as inclusive or exclusive
The start of the time range
The end of the time range
Whether to treat the time range as inclusive or exclusive
The start of the time range
The end of the time range
Whether to treat the time range as inclusive or exclusive
The status of the job
JOB_STATUS_UNSPECIFIED, JOB_STATUS_PENDING, JOB_STATUS_RUNNING, JOB_STATUS_COMPLETED, JOB_STATUS_FAILED, JOB_STATUS_CANCELED Policy ID that created the job
The maximum number of jobs to return
A token identifying the page to return; for keyset pagination
A successful response.
Show child attributes
JOB_STATUS_UNSPECIFIED, JOB_STATUS_PENDING, JOB_STATUS_RUNNING, JOB_STATUS_COMPLETED, JOB_STATUS_FAILED, JOB_STATUS_CANCELED Content associated with this job. In responses, includes the content hash and any metadata provided with the original request.
Show child attributes
Show child attributes
A report on the result of evaluating a policy against a piece of content/input.
Show child attributes
This is the title of the policy as it appears in the policy editor. Do not use this to identify a policy. Use the policy_id instead.
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED Reports on the evaluation of each SECTION or LABEL block in the policy.
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED Each assertion in each section is evaluated
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED The text of the assertion.
Outcome of an EXCEPT WHEN or UNLESS block, if present.
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED Each assertion in the exception is evaluated
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED The text of the assertion.
Report on the result of a single assertion in a policy.
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED Report on the result of a single assertion in a policy.
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED Outcome of an EXCEPT WHEN or UNLESS block, if present.
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED Each assertion in the exception is evaluated
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED The text of the assertion.
Report on the result of a single assertion in a policy.
Show child attributes
Evaluation outcome. TRUE, FALSE or FAILED.
OUTCOME_UNSPECIFIED, OUTCOME_FALSE, OUTCOME_TRUE, OUTCOME_FAILED The hashing algorithm used will appear at the front of the hash value in this field (i.e., 'fnv1a128::hash-value')
Report on the result of a single assertion in a policy.
Labels that matched the content. The keys of the map are the label names, and the values are the scores for each label. This field provides a simple way to identify which labels matched the content without the need to dig into each section report.
Show child attributes
Usage related to this policy evaluation.
Show child attributes
The number of tokens that were sent to the service in the form of content.
The number of tokens that Clavata billed for this evaluation.
The policy complexity multiplier that was used to calculate the final billed tokens.