Videos

Cancel Video

Changed on

Cancel an in-flight Glory League video submission.

Marks the submission terminally and best-effort halts the league processing pipeline. Only submissions still pending/processing can be cancelled; an already-cancelled submission returns success idempotently, and completed/failed ones return 409.

When VIDEO_ENDPOINTS_LIVE is False, returns a preview response without DB writes.

post/api/v1/videos/{video_uuid}/cancel

Request

  • Base URL
    https://developer.preciser.io
  • URL
    https://developer.preciser.io/api/v1/videos/{video_uuid}/cancel
  • Auth
    none declared. Required headers: x-api-key, League

Path parameters

video_uuidstring required

Headers

x-api-keystring required

Required API key issued by Preciser.

Leaguestring required

Required tenant/database selector, for example pitchbio-master.

Response

Successful Response

successboolean required

Whether the cancellation was accepted

video_uuidstring required

The video UUID

statusstring required

Resulting status (always 'cancelled' on success)

messagestring required

Human-readable detail

credit_refundedboolean required

True only when cancellation happened before game info was submitted and the reserved credit is available again

Changes

  • 9b0abde08b06Revision changes
    • breaking

      the header request parameter League became required

    • breaking

      the header request parameter x-api-key became required

    • breaking

      header request parameter League list-of-types was narrowed by removing types null

    • breaking

      header request parameter x-api-key list-of-types was narrowed by removing types null

    • info

      for the header request parameter League, the type was generalized from no type to string

    • info

      for the header request parameter x-api-key, the type was generalized from no type to string

  • cd89acfd6adfRevision changes
    • info

      added the required property to the response with the status