Additional details about the status.

interface RealtimeResponseStatus {
    error?: OpenAIClient.Beta.Realtime.RealtimeResponseStatus.Error;
    reason?:
        | "max_output_tokens"
        | "content_filter"
        | "turn_detected"
        | "client_cancelled";
    type?:
        | "completed"
        | "failed"
        | "incomplete"
        | "cancelled";
}

Properties

Properties

A description of the error that caused the response to fail, populated when the status is failed.

reason?:
    | "max_output_tokens"
    | "content_filter"
    | "turn_detected"
    | "client_cancelled"

The reason the Response did not complete. For a cancelled Response, one of turn_detected (the server VAD detected a new start of speech) or client_cancelled (the client sent a cancel event). For an incomplete Response, one of max_output_tokens or content_filter (the server-side safety filter activated and cut off the response).

type?:
    | "completed"
    | "failed"
    | "incomplete"
    | "cancelled"

The type of error that caused the response to fail, corresponding with the status field (completed, cancelled, incomplete, failed).