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

# Cancel job

> Cancel an unfinished job and release its reserved credits.

Requires `subtitles:write`. No request body or idempotency header is required.

Queued and processing jobs become `canceled`. Jobs already completed, failed, or canceled keep their existing state. Cancellation does not refund a completed job.


## OpenAPI

````yaml openapi.json POST /v1/jobs/{id}/cancel
openapi: 3.1.0
info:
  title: CaptionCraft API
  version: 1.0.0
  description: >-
    Create captioned MP4 videos from a video URL. Jobs are asynchronous. Poll
    every 5 seconds. Media is retained for 24 hours; request a fresh job
    response to retrieve result URLs. All word timestamps use seconds.
servers:
  - url: https://api.captioncraft.studio
security: []
paths:
  /v1/jobs/{id}/cancel:
    post:
      summary: Cancel an unfinished job and release credits
      operationId: cancelSubtitleJob
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: >-
            Job ID returned by a create request. The job must belong to your
            account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
              example:
                id: example_job_id
                status: canceled
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing key scope or disabled account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Job or endpoint not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate or concurrency limit exceeded; honor Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              description: Minimum retry delay in seconds.
              schema:
                type: integer
                example: 5
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
          required:
            - code
            - message
            - request_id
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: cc_ API key

````