Skip to main content
POST
/
v1
/
jobs
Create a new job
curl --request POST \
  --url https://gateway.app.clavata.ai:8443/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contentData": [
    {
      "text": "<string>",
      "image": "aSDinaTvuI8gbWludGxpZnk=",
      "imageUrl": "<string>",
      "metadata": {}
    }
  ],
  "policyId": "<string>",
  "threshold": 123,
  "expedited": true,
  "options": {
    "options": {}
  }
}
'
{
  "job": {
    "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
          },
          "labelId": "<string>",
          "labelVersionId": "<string>"
        },
        "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,
    "labelId": "<string>",
    "labelVersionId": "<string>",
    "jobType": "JOB_TYPE_UNSPECIFIED"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.clavata.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
contentData
Content Data · object[]
required

The content data to be evaluated. Only one content type should be set per entry.

​
policyId
string
required
​
threshold
number<double>

The threshold to use for truthyness. If not set a default value will be used.

​
expedited
boolean

If set, the job will be evaluated in expedited mode, prioritizing speed over cost.

​
webhook
Webhook Details (Optional) · object

A POST request to make when the job is complete.

​
options
object

Options for evaluation behavior.

Response

A successful response.

​
job
Job · object

A unique evaluation job that has compared a policy to one or more pieces of content