> ## Documentation Index
> Fetch the complete documentation index at: https://docs.viggle.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel Render

> Cancel a queued or processing Render.

`DELETE /v1/renders/{render_id}` cancels a Render owned by the current account. For a terminal Render, it returns its current state.

## Request parameters

| Parameter   | Type   | Required | Description                                     |
| ----------- | ------ | :------: | ----------------------------------------------- |
| `render_id` | string |    Yes   | Full public Render ID beginning with `render_`. |

## Response parameters

Returns `200 OK` with a Render object.

| Field          | Type            | Always present | Description                                              |
| -------------- | --------------- | :------------: | -------------------------------------------------------- |
| `id`           | string          |       Yes      | Render ID.                                               |
| `status`       | string          |       Yes      | Usually `cancelled`; may be an existing terminal status. |
| `progress`     | integer or null |       Yes      | Progress when available.                                 |
| `stage`        | string or null  |       Yes      | Processing stage when available.                         |
| `video_url`    | string or null  |       Yes      | Output URL only if already ready.                        |
| `alpha_url`    | string or null  |       Yes      | Alpha output URL when available.                         |
| `created_at`   | string or null  |       Yes      | Creation timestamp.                                      |
| `completed_at` | string or null  |       Yes      | Completion timestamp.                                    |
| `error`        | object or null  |       Yes      | Failure details when applicable.                         |

```json theme={null}
{"id":"render_789ghi","status":"cancelled","progress":null,"stage":null,"video_url":null,"alpha_url":null,"created_at":null,"completed_at":null,"error":null}
```

## Examples

<CodeGroup>
  ```go Go theme={null}
  req,_:=http.NewRequest("DELETE","https://apis.viggle.ai/v1/renders/render_789ghi",nil); req.Header.Set("Authorization","Bearer "+os.Getenv("VIGGLE_API_KEY")); resp,err:=http.DefaultClient.Do(req); if err!=nil { panic(err) }; defer resp.Body.Close()
  ```

  ```javascript JavaScript theme={null}
  const response=await fetch("https://apis.viggle.ai/v1/renders/render_789ghi",{method:"DELETE",headers:{Authorization:`Bearer ${process.env.VIGGLE_API_KEY}`}}); const render=await response.json();
  ```

  ```python Python theme={null}
  import os, requests
  response=requests.delete("https://apis.viggle.ai/v1/renders/render_789ghi",headers={"Authorization":f"Bearer {os.environ['VIGGLE_API_KEY']}"}); response.raise_for_status(); render=response.json()
  ```

  ```bash cURL theme={null}
  curl -X DELETE "https://apis.viggle.ai/v1/renders/render_789ghi" -H "Authorization: Bearer $VIGGLE_API_KEY"
  ```
</CodeGroup>


## OpenAPI

````yaml DELETE /v1/renders/{render_id}
openapi: 3.0.3
info:
  title: Viggle API
  description: Generate AI-powered character animation videos
  version: 2.0.0
  contact:
    name: Viggle Support
    url: https://viggle.ai
servers:
  - url: https://apis.viggle.ai
    description: Production server
security: []
paths:
  /v1/renders/{render_id}:
    delete:
      summary: Cancel Render
      operationId: v1CancelRender
      responses:
        '200':
          description: Render

````