Get a Decision

This endpoint gets the results of a decision.

Example Request

curl --location --request GET 'https://api.safetykit.com/v1/decisions/content_01h2m7qdmdjckc30e1mnq6xqfd' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api_key>'

Response

{
  "decision_id": "example_01h2m7qdmdjckc30e1mnq6xqfd",
  "decision_status": "SUCCESS",
  "metadata": {},
  "result": "violating",
  "labels": [
    {
      "name": "Counerfeit brands",
      "applied": true,
      "explanation": "The product is stated to be a Burberry item, a well-known brand"
    },
    {
      "name": "Illegal drugs",
      "applied": false,
      "explanation": "The product is a handbag, and does not contain any illegal drugs"
    }
  ]
}

Response

decision_id · string

Unique ID of the decision, used to retrieve the results

decision_status · string

Status of the decision (“SUCCESS”, “PENDING”, or “ERROR”)

metadata · object

Any key-value pairs that were included when creating the decision.

result · string | null

The result of the policy (possible values are determined by the policy)

labels · array | null

Hide labels

label · Label Object

Hide properties

name · string

The name of the label

applied · boolean

Whether or not the label was applied in this decision

explanation · string

An explanation of why the label was applied or not applied in Markdown format

Example Request

curl --location --request GET 'https://api.safetykit.com/v1/decisions/content_01h2m7qdmdjckc30e1mnq6xqfd' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api_key>'

Response

{
  "decision_id": "example_01h2m7qdmdjckc30e1mnq6xqfd",
  "decision_status": "SUCCESS",
  "metadata": {},
  "result": "violating",
  "labels": [
    {
      "name": "Counerfeit brands",
      "applied": true,
      "explanation": "The product is stated to be a Burberry item, a well-known brand"
    },
    {
      "name": "Illegal drugs",
      "applied": false,
      "explanation": "The product is a handbag, and does not contain any illegal drugs"
    }
  ]
}