Represents a step in execution of a run.

interface RunStep {
    assistant_id: string;
    cancelled_at: null | number;
    completed_at: null | number;
    created_at: number;
    expired_at: null | number;
    failed_at: null | number;
    id: string;
    last_error: null | OpenAIClient.Beta.Threads.Runs.Steps.RunStep.LastError;
    metadata: unknown;
    object: "thread.run.step";
    run_id: string;
    status:
        | "completed"
        | "failed"
        | "cancelled"
        | "expired"
        | "in_progress";
    step_details: MessageCreationStepDetails | ToolCallsStepDetails;
    thread_id: string;
    type: "tool_calls" | "message_creation";
    usage: null | OpenAIClient.Beta.Threads.Runs.Steps.RunStep.Usage;
}

Properties

assistant_id: string

The ID of the assistant associated with the run step.

cancelled_at: null | number

The Unix timestamp (in seconds) for when the run step was cancelled.

completed_at: null | number

The Unix timestamp (in seconds) for when the run step completed.

created_at: number

The Unix timestamp (in seconds) for when the run step was created.

expired_at: null | number

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

failed_at: null | number

The Unix timestamp (in seconds) for when the run step failed.

id: string

The identifier of the run step, which can be referenced in API endpoints.

The last error associated with this run step. Will be null if there are no errors.

metadata: unknown

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

object: "thread.run.step"

The object type, which is always thread.run.step.

run_id: string

The ID of the run that this run step is a part of.

status:
    | "completed"
    | "failed"
    | "cancelled"
    | "expired"
    | "in_progress"

The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.

The details of the run step.

thread_id: string

The ID of the thread that was run.

type: "tool_calls" | "message_creation"

The type of run step, which can be either message_creation or tool_calls.

Usage statistics related to the run step. This value will be null while the run step's status is in_progress.

""