Report API

Generate Pdf Report

Changed on

Get PDF report if available, or trigger generation if not.

  • Returns the PDF if it is already generated
  • Triggers generation and returns 202 if not available
  • Returns processing status if generation is already in progress
  • Returns 409 with body {"detail": "media_unavailable"} when the owner's account is gone. Retrying does not help.
get/v2/reports/pdf/{media_id}

Request

  • Base URL
    https://api.imentiv.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

media_idstring required

Unique identifier of the media

Query parameters

media_typestring required

Type: Only 'video' is allowed at present

callback_urlstring nullable

Callback URL for completion notification. Must be an https URL on a publicly reachable host.

Response

PDF stream when the artifact is ready; JSON {id, message, status} when this request triggered generation.

idstring required
messagestring required
statusstring required

Changes

    • info

      added the non-success response with the status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the media type application/pdf for the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the success response with the status