Videos

Notify Video Status

Changed on

Trigger webhooks for video processing completion or failure.

When VIDEO_ENDPOINTS_LIVE is False, returns a preview response without triggering webhooks.

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

Request

  • Base URL
    https://developer.preciser.io
  • URL
    https://developer.preciser.io/api/v1/videos/{video_uuid}/notify
  • 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.

Request body

status'completed' | 'failed' required

Video processing status

messagestring nullable

Additional message (e.g., error details for failed status)

Example request

{
  "status": "completed"
}

Response

Successful Response

successboolean required

Whether the operation was successful

messagestring required

Status message

webhooks_triggeredinteger required

Number of webhook deliveries initiated

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