Vionlabs Tasks API
Vionlabs API for creating, retrieving and deactivating processing tasks for catalog assets and product versions. Tasks are used to orchestrate processing and expose the current state of requested work across the system.
[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
Customer's identifier for an asset in the catalog
Specify product name
"adbreaks" | "contextual_adbreak" | "emotions" | "fingerprint" | "fingerprintplus" | "jitpreviews" | "jitthumbnails" | "markers" | "nudity" | "profanity" | "semantic" | "similar" | "content_summary" | "semantic_scenes" | "vertical_conversion" | "scene_tags"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": {}
}
]
}[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
Customer's identifier for an asset in the catalog
Specify product name
"adbreaks" | "contextual_adbreak" | "emotions" | "fingerprint" | "fingerprintplus" | "jitpreviews" | "jitthumbnails" | "markers" | "nudity" | "profanity" | "semantic" | "similar" | "content_summary" | "semantic_scenes" | "vertical_conversion" | "scene_tags"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": {}
}
]
}[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
Customer's identifier for an asset in the catalog
Specify product name
"adbreaks" | "contextual_adbreak" | "emotions" | "fingerprint" | "fingerprintplus" | "jitpreviews" | "jitthumbnails" | "markers" | "nudity" | "profanity" | "semantic" | "similar" | "content_summary" | "semantic_scenes" | "vertical_conversion" | "scene_tags"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": {}
}
]
}[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
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": {}
}
]
}