Render Job Events Reference

RenderJobInitiatedEvent

id: string

entity: stringconstant:event

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

createdAt: string

ISO date when event was created

type: stringconstant:renderJob.initiated

BaseRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

Example:

{
  "id": "17100706970917267",
  "type": "renderJob.initiated",
  "entity": "event",
  "apiVersion": 1,
  "livemode": false,
  "createdAt": "2024-03-10T11:38:17.815Z",
  "current": {
    "id": "ltlfxs0eejy3knru",
    "status": "queued",
    "apiVersion": 1,
    "livemode": false,
    "hash": "some-hash",
    "ownerId": "user_aninix-admin",
    "entity": "renderJob",
    "storyboard": {
      "projects": [
        {
          "snapshot": "example-snapshot.json",
          "scaleFactor": 1,
          "endInSeconds": 0,
          "startInSeconds": 0
        }
      ],
      "renderOptions": {
        "fps": 60,
        "audio": "string",
        "format": "mp4",
        "audioBitrate": 192,
        "videoBitrate": 4000
      }
    },
    "metadata": {},
    "createdAt": "2024-03-10T11:38:13.646Z"
  }
}

RenderJobQueuedEvent

id: string

entity: stringconstant:event

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

createdAt: string

ISO date when event was created

type: stringconstant:renderJob.queued

QueuedRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:queued

Example:

{
  "id": "ltlg2bxqryd2q6ms",
  "type": "renderJob.queued",
  "entity": "event",
  "apiVersion": 1,
  "livemode": false,
  "createdAt": "2024-03-10T11:41:46.094Z",
  "current": {
    "id": "ltlg20c19sthf1sv",
    "status": "queued",
    "apiVersion": 1,
    "livemode": false,
    "hash": "some-hash",
    "ownerId": "user_aninix-admin",
    "entity": "renderJob",
    "storyboard": {
      "projects": [
        {
          "snapshot": "example-snapshot.json",
          "scaleFactor": 1,
          "endInSeconds": 0,
          "startInSeconds": 0
        }
      ],
      "renderOptions": {
        "fps": 60,
        "audio": "string",
        "format": "mp4",
        "audioBitrate": 192,
        "videoBitrate": 4000
      }
    },
    "metadata": {},
    "createdAt": "2024-03-10T11:41:31.057Z",
    "updatedAt": "2024-03-10T11:41:46.084Z"
  }
}

RenderJobProcessStartedEvent

id: string

entity: stringconstant:event

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

createdAt: string

ISO date when event was created

type: stringconstant:renderJob.processStarted

QueuedRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:queued

ProcessingRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:processing

Example:

{
  "id": "ltlfxvwgecur9tm2",
  "type": "renderJob.processStarted",
  "entity": "event",
  "apiVersion": 1,
  "livemode": false,
  "createdAt": "2024-03-10T11:38:18.688Z",
  "previous": {
    "status": "queued"
  },
  "current": {
    "id": "ltlfxs0eejy3knru",
    "status": "processing",
    "apiVersion": 1,
    "livemode": false,
    "hash": "some-hash",
    "ownerId": "user_aninix-admin",
    "entity": "renderJob",
    "storyboard": {
      "projects": [
        {
          "snapshot": "example-snapshot.json",
          "scaleFactor": 1,
          "endInSeconds": 0,
          "startInSeconds": 0
        }
      ],
      "renderOptions": {
        "fps": 60,
        "audio": "string",
        "format": "mp4",
        "audioBitrate": 192,
        "videoBitrate": 4000
      }
    },
    "metadata": {},
    "createdAt": "2024-03-10T11:38:13.646Z",
    "updatedAt": "2024-03-10T11:38:18.671Z"
  }
}

RenderJobCompletedEvent

id: string

entity: stringconstant:event

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

createdAt: string

ISO date when event was created

type: stringconstant:renderJob.completed

ProcessingRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:processing

CompletedRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:completed

fileUrl: string

Used to load a rendered file. Streaming is supported. File URL is available for 7 days. If you need to refresh it you have to send GET request to the `RenderJob` endpount (TBD).

Example:

{
  "id": "ltlfy3lui1a22vk7",
  "type": "renderJob.completed",
  "entity": "event",
  "apiVersion": 1,
  "livemode": false,
  "createdAt": "2024-03-10T11:38:28.674Z",
  "previous": {
    "status": "processing",
    "updatedAt": "2024-03-10T11:38:18.671Z"
  },
  "current": {
    "id": "ltlfxs0eejy3knru",
    "fileUrl": "/renders/8b5d1120-0419-41cd-9c09-f56b29144a88.mp4",
    "status": "completed",
    "apiVersion": 1,
    "livemode": false,
    "hash": "some-hash",
    "ownerId": "user_aninix-admin",
    "entity": "renderJob",
    "storyboard": {
      "projects": [
        {
          "snapshot": "example-snapshot.json",
          "scaleFactor": 1,
          "endInSeconds": 0,
          "startInSeconds": 0
        }
      ],
      "renderOptions": {
        "fps": 60,
        "audio": "string",
        "format": "mp4",
        "audioBitrate": 192,
        "videoBitrate": 4000
      }
    },
    "metadata": {},
    "createdAt": "2024-03-10T11:38:13.646Z",
    "updatedAt": "2024-03-10T11:38:28.669Z"
  }
}

RenderJobCancelledEvent

id: string

entity: stringconstant:event

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

createdAt: string

ISO date when event was created

type: stringconstant:renderJob.cancelled

QueuedRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:queued

CancelledRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:cancelled

Example:

{
  "id": "ltlg2bxqryd2q6ms",
  "type": "renderJob.cancelled",
  "entity": "event",
  "apiVersion": 1,
  "livemode": false,
  "createdAt": "2024-03-10T11:41:46.094Z",
  "previous": {
    "status": "queued",
    "updatedAt": "2024-03-10T11:41:36.082Z"
  },
  "current": {
    "id": "ltlg20c19sthf1sv",
    "status": "cancelled",
    "apiVersion": 1,
    "livemode": false,
    "hash": "some-hash",
    "ownerId": "user_aninix-admin",
    "entity": "renderJob",
    "storyboard": {
      "projects": [
        {
          "snapshot": "example-snapshot.json",
          "scaleFactor": 1,
          "endInSeconds": 0,
          "startInSeconds": 0
        }
      ],
      "renderOptions": {
        "fps": 60,
        "audio": "string",
        "format": "mp4",
        "audioBitrate": 192,
        "videoBitrate": 4000
      }
    },
    "metadata": {},
    "createdAt": "2024-03-10T11:41:31.057Z",
    "updatedAt": "2024-03-10T11:41:46.084Z"
  }
}

RenderJobFailedEvent

id: string

entity: stringconstant:event

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

createdAt: string

ISO date when event was created

type: stringconstant:renderJob.failed

ProcessingRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:processing

FailedRenderJob

id: string

entity: stringconstant:renderJob

apiVersion: numberconstant:1

API schema version

livemode: boolean

When true then production mode is enabled

hash: string

Hash of storyboard project IDs and audio name. This allows to get a render jobs for selected frames in the UI.

ownerId: string

Id of the user or team who created the job. For user it would have prefix `user-` and for team `team-`. For example `user-8715b5d1-0e57-48d8-b826-ba728f0ac0c8`.

createdAt: string

Date the job was created.

updatedAt: stringOptional

Date the job was updated.

metadata: object

Any additional JSON data that should be attached to the job. It may be useful to add a specific client ID.

status: stringconstant:failed

Before moving to this status Aninix will try to rerender video up to 3 times with exponential backoff. Only after all 3 failed attempts RenderJob would be marked as `failed`.

failReason: string

failMessage: string

Example:

{
  "id": "ltlg2bxqryd2q6ms",
  "type": "renderJob.failed",
  "entity": "event",
  "apiVersion": 1,
  "livemode": false,
  "createdAt": "2024-03-10T11:41:46.094Z",
  "previous": {
    "status": "processing",
    "updatedAt": "2024-03-10T11:41:36.082Z"
  },
  "current": {
    "id": "ltlg20c19sthf1sv",
    "failReason": "test_failed_status",
    "failMessage": "TBD",
    "status": "failed",
    "apiVersion": 1,
    "livemode": false,
    "hash": "some-hash",
    "ownerId": "user_aninix-admin",
    "entity": "renderJob",
    "storyboard": {
      "projects": [
        {
          "snapshot": "example-snapshot.json",
          "scaleFactor": 1,
          "endInSeconds": 0,
          "startInSeconds": 0
        }
      ],
      "renderOptions": {
        "fps": 60,
        "audio": "string",
        "format": "mp4",
        "audioBitrate": 192,
        "videoBitrate": 4000
      }
    },
    "metadata": {},
    "createdAt": "2024-03-10T11:41:31.057Z",
    "updatedAt": "2024-03-10T11:41:46.084Z"
  }
}