Type reference

@glexir/sdk exports a TypeScript type for every request, response and stream event it handles. This page lists every export, grouped by area, with a one-line description and a link to the page that covers it in depth.

Import types with import type. The Responses API object is named Response, like the global Response, so alias it:

import Glexir from "@glexir/sdk";
import type { ResponseCreateParamsNonStreaming, ResponseInputItem, Response as GlexirResponse } from "@glexir/sdk";

const glexir = new Glexir();

const input: ResponseInputItem[] = [{ role: "user", content: "Name three planets." }];
const params: ResponseCreateParamsNonStreaming = { model: "gpt-5.4-mini", input, store: false };

const response: GlexirResponse = await glexir.responses.create(params);
console.log(response.output_text);

Request parameter types accept unknown keys where OpenAI adds parameters often (ResponseCreateParamsBase, ChatCompletionCreateParamsBase, EmbeddingCreateParams, TranscriptionCreateParamsBase). Unknown keys are sent unchanged. Model and enum types such as ChatModel and ServiceTier list known values and also accept any string.

Client and runtime

Errors

Shared

Responses

Covered on Responses and Streaming.

Conversations

Covered on Conversations.

Chat Completions

Covered on Chat Completions.

Audio

Covered on Audio.

Embeddings, files, batches and models