# Cancel queued speech

`POST https://api.vidmoat.com/v1/speech/generations/{id}/cancel`

- Scope: `speech.generate`
- Cost: Free; refunds the queued job

Cancel only work that has not started inference. A job already running, or being submitted to the worker, returns 409. Retry status rather than assuming it was cancelled.

### Path parameters

- `id` (string, required): A voice or generation ID belonging to the credential owner.

## Response

Returns `200`.

## Errors

Besides the errors any request can get ([authentication](https://developer.vidmoat.com/developer/docs/authentication#when-a-request-is-refused), [rate limits](https://developer.vidmoat.com/developer/docs/rate-limits)):

| Status | Code | When |
| --- | --- | --- |
| 409 | [`conflict`](https://developer.vidmoat.com/developer/docs/errors#conflict) | The idempotency key belongs to different inputs, or the job is not in the required state. |
| 503 | [`unavailable`](https://developer.vidmoat.com/developer/docs/errors#unavailable) | Inference, private storage, configured pilot billing or the limiter is unavailable. Nothing new is charged before admission. |

## Request examples

```bash curl
curl --fail-with-body -X POST "https://api.vidmoat.com/v1/speech/generations/$ID/cancel" -H "Authorization: Bearer $VIDMOAT_KEY"
```

```js Node
const ID = 'YOUR_PROJECT_ID';

const res = await fetch(`https://api.vidmoat.com/v1/speech/generations/${ID}/cancel`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

ID = "YOUR_PROJECT_ID"

res = requests.post(
    f"https://api.vidmoat.com/v1/speech/generations/{ID}/cancel",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

## Example response

```json
{"status":"cancelled","refunded":true,"credits":0}
```

---

Source: https://developer.vidmoat.com/developer/docs/api/speech/cancel
Previous: [Get an audio download](https://developer.vidmoat.com/developer/docs/api/speech/download.md)
Next: [Delete generated speech](https://developer.vidmoat.com/developer/docs/api/speech/delete-generation.md)
All documentation: https://developer.vidmoat.com/llms-full.txt