Skip to main content
POST
/
file
/
{file_id}
/
cancel
Cancel file processing
curl --request POST \
  --url https://api.vidnavigator.com/v1/file/{file_id}/cancel \
  --header 'X-API-Key: <api-key>'
{
  "status": "success",
  "data": {
    "file_id": "<string>",
    "file_name": "<string>",
    "message": "<string>"
  }
}
Cancel an ongoing file upload or processing job.

​
Path Parameter

  • file_id (string, required)

​
Example Request

cURL
curl -X POST "https://api.vidnavigator.com/v1/file/file_abc123/cancel" \
  -H "X-API-Key: YOUR_API_KEY"

​
Success Response (200 OK)

Returns a confirmation that the file processing has been cancelled. 
{
  "status": "success",
  "data": {
    "file_id": "file_abc123",
    "file_name": "processing_video.mp4",
    "message": "File cancelled successfully"
  }
}

Authorizations

​
X-API-Key
string
header
required

API key authentication. Include your VidNavigator API key in the X-API-Key header.

Path Parameters

​
file_id
string
required

The ID of the file to cancel

Response

File cancelled successfully

​
status
enum<string>
Available options:
success
​
data
object