API reference / Internal callbacks

Internal callbacks

Called by the transcoder and packager services — not for direct client use.

POST /api/v1/internal/encore-callback

Transcoder job progress/completion callback. Invoked by the transcoder, not for direct client use.

Request

Request body (application/json)
{
  "externalId": "string",
  "status": "string",
  "message": "string",
  "output": [
    {
      "file": "string",
      "type": "string",
      "videoStreams": [
        {
          "width": null,
          "height": null
        }
      ],
      "overallBitrate": 0
    }
  ]
}

Response

Response 200 (application/json)
{
  "applied": true,
  "renditionCount": 0
}

POST /api/v1/internal/packagerCallback/failure

Packager failure callback. Invoked by the packager service, not for direct client use.

Request

Request body (application/json)
{
  "message": "string"
}

Response

Response 200 (application/json)
{
  "ok": true
}

POST /api/v1/internal/packagerCallback/success

Packager success callback. Invoked by the packager service, not for direct client use.

Request

Request body (application/json)
{
  "url": "string",
  "jobId": "string",
  "outputPath": "string"
}

Response

Response 200 (application/json)
{
  "ok": true
}