Skip to main content
GET
/
v1
/
orders
/
{order_id}
Get order
curl --request GET \
  --url https://api.human.prod.artistree.io/v1/orders/{order_id} \
  --header 'Authorization: Bearer <token>'
{
  "order_id": "<string>",
  "username": "<string>",
  "email": "<string>",
  "order_state": "In Progress",
  "order_title": "<string>",
  "asset_id": "<string>",
  "asset_name": "<string>",
  "asset_last_modified_timestamp": "<string>",
  "ordered_by": "<string>",
  "creation_time": "<string>",
  "asset_preview_url": "<string>",
  "analysis_list": [
    {
      "analysis_type": "<string>",
      "analysis_passed": true
    }
  ],
  "analysis_failed_items": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "confidence": 0,
  "remediation": 0,
  "annotations": [
    {
      "id": "<string>",
      "bodies": [
        {
          "value": "<string>",
          "id": "<string>",
          "annotation": "<string>"
        }
      ],
      "properties": {
        "needs_remediation": true,
        "ai_likelihood": 123
      },
      "target": {
        "annotation": "<string>",
        "selector": {
          "type": "RECTANGLE",
          "geometry": {
            "bounds": {
              "minX": 123,
              "minY": 123,
              "maxX": 123,
              "maxY": 123
            },
            "x": 123,
            "y": 123,
            "w": 123,
            "h": 123,
            "points": [
              [
                123
              ]
            ]
          }
        }
      }
    }
  ],
  "project": {
    "id": "<string>",
    "name": "<string>",
    "userRole": "<string>"
  },
  "reviewed_by": "<string>",
  "review_timestamp": "<string>",
  "layers_info": [
    {
      "layer_name": "<string>",
      "layer_url": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

lang
string | null

Language preference for the response

Path Parameters

order_id
string
required
Required string length: 36

Query Parameters

download
boolean
default:false

Response

The order details

order_id
string
required

The unique identifier for the order.

username
string
required

The username of the user who created the order.

email
string
required

The email of the user who created the order.

order_state
enum<string>
required

The current state of the order. One of: 'In Progress', 'Human Certified', 'Action Required', 'Reviewed', 'Failed', 'Unsupported File'.

Available options:
In Progress,
Human Certified,
Action Required,
Reviewed,
Failed,
Unsupported File
order_title
string
required

The display title of the order.

asset_id
string
required

The unique identifier for the uploaded asset.

asset_name
string
required

The filename of the uploaded asset.

asset_last_modified_timestamp
string
required

Unix timestamp of the last modification time of the asset, serialized as a string, as provided at order creation.

ordered_by
string | null
required

The entity that placed the order, e.g. an artist name. May differ from username.

creation_time
string
required

ISO 8601 timestamp of when the order was created.

asset_preview_url
string | null

A presigned URL for a preview image of the asset. Null if no preview is available.

analysis_list
OrderAnalysisLine · object[]

The list of analysis checks performed on the asset and whether each passed.

analysis_failed_items
string[]

Names of the asset segments or layers that failed analysis.

tags
string[]

User-defined tags attached to the order.

confidence
number
default:0

Confidence score between 0.0 and 1.0 indicating how confident the system is in its certification result.

remediation
number
default:0

Remediation recommendation. 0.0 = not set, 0.5 = not recommended, 1.0 = recommended.

annotations
Annotation · object[]

System-generated annotations on the asset.

project
Project · object

The project this order belongs to, including the requesting user's role. Null for personal certificate orders.

reviewed_by
string | null

Email of the reviewer who marked this order as reviewed. Null if not yet reviewed.

review_timestamp
string | null

ISO 8601 timestamp of when the order was reviewed. Null if not yet reviewed.

layers_info
LayerInfo · object[]

Presigned download URLs for individual asset layers, if the asset contains multiple layers.