Triangle pointing up
Reference

Scan

Get a scan by id.

Read the scanning documentation to understand how to use this endpoint.

GET/scan/{id}
Authorization<token>

Use the format: Api-Key <token> as the value.

In: header

Path Parameters

idstring

Scan id

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
Formatuuid

Response Body

{
  "id": "2a5e56f5-75f3-4f01-ac85-6e796f5cde87",
  "name": "OutliersFinder",
  "status": "Running",
  "input": {
    "query": [
      "UCUyeluBRhGPCW4rPe_UvBZQ",
      "UCX6OQ3DkcsbYNE6H8uQQuVA"
    ],
    "threshold": {
      "channels": 9007199254740991,
      "outlierVideos": 1000
    }
  },
  "endedAt": null,
  "createdAt": "2025-09-20T12:44:15.010Z",
  "updatedAt": "2025-09-20T12:44:15.010Z"
}
{
  "error": {
    "errors": [
      {
        "code": "string",
        "validation": "string",
        "message": "string",
        "path": [
          "string"
        ]
      }
    ]
  },
  "status": "string"
}
{
  "error": {
    "message": "string"
  },
  "status": "string"
}
{
  "error": {
    "message": "string"
  },
  "status": "string"
}
{
  "error": {
    "message": "string",
    "rateLimit": {
      "limit": -9007199254740991,
      "current": -9007199254740991,
      "remaining": -9007199254740991,
      "resetTime": "2019-08-24T14:15:22Z"
    }
  },
  "status": "string"
}