Table of Contents

Class SoraVideoJob

public class SoraVideoJob : IPollingJob
Inheritance
object
SoraVideoJob

Properties

CompletedAt

Optional. Unix timestamp (seconds) for when the job completed, if finished.

public UnixTime? CompletedAt { get; set; }

Property Value

UnixTime?

CreatedAt

Required. Unix timestamp (seconds) for when the job was created.

public UnixTime CreatedAt { get; set; }

Property Value

UnixTime

Error

Optional. Error payload that explains why generation failed, if applicable.

public SoraVideoJob.SoraError Error { get; set; }

Property Value

SoraVideoJob.SoraError

ExpiresAt

Optional. Unix timestamp (seconds) for when the downloadable assets expire, if set.

public UnixTime? ExpiresAt { get; set; }

Property Value

UnixTime?

Id

Required. Unique identifier for the video job.

public string Id { get; set; }

Property Value

string

Model

Required. The video generation model that produced the job.

public string Model { get; set; }

Property Value

string

ObjectType

Required. The object type, which is always video.

public string ObjectType { get; set; }

Property Value

string

Progress

Optional. Approximate completion percentage for the generation task.

public int? Progress { get; set; }

Property Value

int?

RemixedFromVideoId

Optional. Identifier of the source video if this video is a remix.

public string RemixedFromVideoId { get; set; }

Property Value

string

Seconds

Required. Duration of the generated clip in seconds.

public string Seconds { get; set; }

Property Value

string

Size

Required. The resolution of the generated video.

public string Size { get; set; }

Property Value

string

Status

Required. Current lifecycle status of the video job.

public string Status { get; set; }

Property Value

string

Methods

IsCompleted()

public bool IsCompleted()

Returns

bool

TryGetError(out string)

public bool TryGetError(out string error)

Parameters

error string

Returns

bool