---
title: "Cancel a prediction"
method: POST
path: "/predictions/{prediction_id}/cancel"
---

# Cancel a prediction

`POST /predictions/{prediction_id}/cancel`

Cancel a prediction that is currently running.

Example cURL request that creates a prediction and then cancels it:

```console
# First, create a prediction
PREDICTION_ID=$(curl -s -X POST \
  -H "Authorization: Bearer $REPLICATE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "prompt": "a video that may take a while to generate"
    }
  }' \
  https://api.replicate.com/v1/models/minimax/video-01/predictions | jq -r '.id')

# Echo the prediction ID
echo "Created prediction with ID: $PREDICTION_ID"

# Cancel the prediction
curl -s -X POST \
  -H "Authorization: Bearer $REPLICATE_API_TOKEN" \
  https://api.replicate.com/v1/predictions/$PREDICTION_ID/cancel
```

## Path parameters

- `prediction_id` string, required

## Response `200`

Success

- SchemasPredictionResponse
  - `completed_at` string, date-time — The time that the model completed the prediction and all outputs were uploaded
  - `created_at` string, date-time, required — The time that the prediction was created
  - `data_removed` boolean, required — Whether the prediction output has been deleted
  - `deadline` string, date-time — The absolute time at which the prediction will be automatically canceled if it has not completed
  - `deployment` string — The name of the deployment that created the prediction
  - `error` string, nullable, required — An error string if the model status is `"failed"`
  - `id` string, required
  - `input` object, required — The prediction input
  - `logs` string — The log output from the model
  - `metrics` object — Additional metrics associated with the prediction
    - `total_time` number — The total time, in seconds, that the prediction took to complete
  - `model` string, required — The name of the model that created the prediction
  - `output` unknown, required
  - `started_at` string, date-time — The time that the model began the prediction
  - `status` 'starting' | 'processing' | 'succeeded' | 'failed' | 'canceled', required
  - `urls` object, required — URLs for working with the prediction
    - `cancel` string, uri, required — Cancel the prediction via API
    - `get` string, uri, required — Retrieve the latest state of the prediction via API
    - `stream` string, uri — An event source to stream the output of the prediction via API
    - `web` string, uri, required — View the prediction in a browser
  - `version` union, required
    - string — The ID of the model version that created the prediction
    - 'hidden' — The model does not support versions, used by official models.

---

[API](https://skmtc.net/replicate/apis/replicate-http-api.md) · [All operations](https://skmtc.net/replicate/apis/replicate-http-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/replicate/replicate-http-api/versions/7a537f433b0b/schema)
