Vionlabs Docs
API Specs

Vionlabs Tasks API

External docs:SwaggerReDoc

Get Task Status

GET
/tasks/catalog-item/{inventory_id}/product/{product}/version/{version}

Return the status of the processing task for the given inventory item and product version.

The status reflects the latest known result for this asset and product feature, which may have been produced by an earlier task run for the same (catalog, inventory_id, product, version) tuple.

Returns 404 if no task and no result are known for this tuple.

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

inventory_id*Inventory Id

Customer's identifier for an asset in the catalog

product*ProductType

Specify product name

Value in"adbreaks" | "contextual_adbreak" | "emotions" | "fingerprint" | "fingerprintplus" | "jitpreviews" | "jitthumbnails" | "markers" | "nudity" | "profanity" | "semantic" | "similar" | "content_summary" | "semantic_scenes" | "vertical_conversion" | "scene_tags"
version*Version

Specify product version. Example: 1.0.1

Response Body

application/json

application/json

curl -X GET "https://example.com/tasks/catalog-item/string/product/adbreaks/version/string"
{
  "status": "pending",
  "error": "string",
  "_links": {
    "property1": {
      "href": "string",
      "method": "string"
    },
    "property2": {
      "href": "string",
      "method": "string"
    }
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Task

POST
/tasks/catalog-item/{inventory_id}/product/{product}/version/{version}

Create a processing task for the given inventory item and product version, or update the existing one if a task for the same (catalog, inventory_id, product, version) already exists.

Idempotency and result reuse:

  • Tasks are uniquely identified by the tuple (catalog, inventory_id, product, version). Calling this endpoint again with the same tuple does not create a second task; the existing task record is upserted in place (its options, active flag and updated timestamp are overwritten). A previously deactivated task is reactivated by such a call.
  • If a result already exists for this asset and product feature, it is reused as-is. The response immediately reports ready (or failed) instead of pending, and no reprocessing is triggered.

Resetting processing:

  • This endpoint cannot be used to reset processing, including after a failure. To have an asset processed again, re-submit it through the Catalog API (PUT /catalog/v1/item) with operations.force_asset_reprocess set to true. Note that this resets processing of all active products and tasks for that asset, not just the product requested here.

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

inventory_id*Inventory Id

Customer's identifier for an asset in the catalog

product*ProductType

Specify product name

Value in"adbreaks" | "contextual_adbreak" | "emotions" | "fingerprint" | "fingerprintplus" | "jitpreviews" | "jitthumbnails" | "markers" | "nudity" | "profanity" | "semantic" | "similar" | "content_summary" | "semantic_scenes" | "vertical_conversion" | "scene_tags"
version*Version

Specify product version. Example: 1.0.1

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/tasks/catalog-item/string/product/adbreaks/version/string" \  -H "Content-Type: application/json" \  -d '{    "priority": "low"  }'
{
  "status": "pending",
  "error": "string",
  "_links": {
    "property1": {
      "href": "string",
      "method": "string"
    },
    "property2": {
      "href": "string",
      "method": "string"
    }
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Deactivate Task

DELETE
/tasks/catalog-item/{inventory_id}/product/{product}/version/{version}

Deactivate a processing task for the given inventory item and product version.

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

inventory_id*Inventory Id

Customer's identifier for an asset in the catalog

product*ProductType

Specify product name

Value in"adbreaks" | "contextual_adbreak" | "emotions" | "fingerprint" | "fingerprintplus" | "jitpreviews" | "jitthumbnails" | "markers" | "nudity" | "profanity" | "semantic" | "similar" | "content_summary" | "semantic_scenes" | "vertical_conversion" | "scene_tags"
version*Version

Specify product version. Example: 1.0.1

Response Body

application/json

application/json

curl -X DELETE "https://example.com/tasks/catalog-item/string/product/adbreaks/version/string"
{
  "status": "pending",
  "error": "string",
  "_links": {
    "property1": {
      "href": "string",
      "method": "string"
    },
    "property2": {
      "href": "string",
      "method": "string"
    }
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Reset Task

PUT
/tasks/catalog-item/{inventory_id}/product/{product}/version/{version}/reset

Reset a failed processing task for the given inventory item and product version, so that it can be reprocessed.

Can only be called when the task's current status is failed; any other status returns 400. Resets the corresponding job (and its dependencies) in catalog-manager.

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

inventory_id*Inventory Id

Customer's identifier for an asset in the catalog

product*ProductType

Specify product name

Value in"adbreaks" | "contextual_adbreak" | "emotions" | "fingerprint" | "fingerprintplus" | "jitpreviews" | "jitthumbnails" | "markers" | "nudity" | "profanity" | "semantic" | "similar" | "content_summary" | "semantic_scenes" | "vertical_conversion" | "scene_tags"
version*Version

Specify product version. Example: 1.0.1

Response Body

application/json

application/json

curl -X PUT "https://example.com/tasks/catalog-item/string/product/adbreaks/version/string/reset"
{}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Task Status

GET
/tasks/catalog-item/{inventory_id}

Returns the status of the processing task for the given inventory item.

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

inventory_id*Inventory Id

Customer's identifier for an asset in the catalog

Response Body

application/json

application/json

curl -X GET "https://example.com/tasks/catalog-item/string"
[
  {
    "task_status": {
      "status": "pending",
      "error": "string"
    },
    "product": "string",
    "version": "string"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Vionlabs Catalog API

Vionlabs API for ingesting and synchronising asset information. Catalog data is central to the operation of the system. To fully understand the models and the implications of operations, developers and integrators should consult the relevant section of the Vionlabs developer documentation.

Vionlabs Binge Markers Results API

Vionlabs API for retrieval of binge marker results (intro/recap skip and end credit detection).