@cavi-ai/api-client/providers/codex/runtime
Package subpath: ./providers/codex/runtime
buildCodexResponseBody
Kind: function
/** Build the OpenAI Responses request body from the universal run-start body. */
export declare function buildCodexResponseBody(body: RuntimeRunStartBody, defaultModel: string, options?: {
background?: boolean;
store?: boolean;
stream?: boolean;
}): Record<string, unknown>;CODEX_RUNTIME_SUPPORT
Kind: variable
export declare const CODEX_RUNTIME_SUPPORT: Readonly<{
runs: true;
streaming: true;
batch: true;
}>;CodexApiClient
Kind: class
export declare class CodexApiClient extends BaseHttpApiClient implements RuntimeClient {
readonly request: HttpApiTransport;
private readonly defaultModel;
private readonly files;
constructor(options: CodexApiClientOptions);
getRuntimeCapabilities(): Promise<RuntimeCapabilities>;
startRun(body: RuntimeRunStartBody): Promise<RuntimeRunStatus>;
getRun(runId: string): Promise<RuntimeRunStatus>;
cancelRun(runId: string): Promise<{
status: string;
}>;
submitBatch(requests: RuntimeBatchRequest[]): Promise<RuntimeBatchStatus>;
getBatch(batchId: string): Promise<RuntimeBatchStatus>;
cancelBatch(batchId: string): Promise<RuntimeBatchStatus>;
getBatchResults(batchId: string): Promise<RuntimeBatchResult[]>;
streamRun(body: RuntimeRunStartBody, handlers: RunEventStreamHandlers, options?: {
signal?: AbortSignal;
}): Promise<void>;
}CodexApiClientOptions
Kind: type
export type CodexApiClientOptions = {
/** OpenAI API key. Keep this backend-owned; do not expose it to browsers/mobile clients. */
apiKey: string;
/** Default model when a run does not specify one. */
defaultModel?: string;
baseUrl?: string;
fetchImpl?: typeof fetch;
onTrace?: HttpApiClientOptions["onTrace"];
defaultTimeoutMs?: number;
};createCodexProviderModule
Kind: function
export declare function createCodexProviderModule(config: CodexApiClientOptions): RuntimeProviderModule;mapOpenAIResponseStreamEvent
Kind: function
export declare function mapOpenAIResponseStreamEvent(sse: SseMessage, runId: string): RunStreamEvent | null;mapOpenAIResponseToRunStatus
Kind: function
/** Map an OpenAI Response object to the canonical run status (incl. normalized tokens). */
export declare function mapOpenAIResponseToRunStatus(response: OpenAIResponse): RuntimeRunStatus;readOpenAIResponseRunId
Kind: function
export declare function readOpenAIResponseRunId(sse: SseMessage): string | null;