Cancel Jobs

Cancel all pending jobs and remove them from queue.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

task_uuidstringRequired

post

/api/task/reset_task

POST /api/task/reset_task HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "task_uuid": "text"
}

Call this API endpoint to cancel all pending jobs and remove them from queue.

Calling this API endpoint before the task is done will result Failed state in Check Status endpoint.

Pricing

We do not charge any addtional credits for calling this API to cancel your task.

Request

Authentication

This API uses bearer key for authentication. You need to include a valid token in the Authorization header for all requests.

Authorization: Bearer RODIN_API_KEY

Body

The API takes one parameter in the POST request body.

Use the uuid field instead of jobs.uuids for task_uuid in the response from the Generation API.

Parameter

Type

Description

task_uuid

string

Required. The UUID of the task you want to reset. Typically you will get it in the response from the Generation API.

Examples

export RODIN_API_KEY="your api key"
curl -X 'POST' \
  'https://vurse.deemos.dev/api/task/reset_task' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "task_uuid": "your-task-uuid"
}'
unset RODIN_API_KEY

import requests

# Constants
ENDPOINT = "https://vurse.deemos.dev/api/task/reset_task"
API_KEY = "your api key"  # Replace with your actual API key
TASK_UUID = "your-task-uuid"  # Replace with your actual task UUID

# Prepare the headers
headers = {
    'accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': f'Bearer {API_KEY}',
}

# Prepare the JSON payload
data = {
    "task_uuid": TASK_UUID
}

# Make the POST request
response = requests.post(ENDPOINT, headers=headers, json=data)

# Parse and return the JSON response
print(response.json())

PreviousCheck Status NextDownload Results

Last updated 11 days ago