Responses API (TypeScript)

Methods, examples, and parameters for client.responses.

Module Overview

Unified Responses API for multimodal generation, tool calls, and structured output.

Available Methods

client.responses.create() - Create a response object.
client.responses.stream() - Stream incremental output events.
client.responses.retrieve() - Fetch a previous response by ID.

Examples

TypeScript

import { TheRouter.ai } from "@therouter/sdk";

const client = new TheRouter.ai({ apiKey: process.env.THEROUTER_API_KEY! });

const response = await client.responses.create({
  model: "openai/gpt-4o",
  input: "Draft release notes for v1.3.",
});

console.log(response.output_text);

responses-response.json

{
  "id": "req_01HXYZ123",
  "module": "responses",
  "status": "ok"
}

Parameter Types

Name	Type	Required	Description
model	string	Required	Target model ID.
input	string \| array	Required	Prompt text or message blocks.
tools	array		Available tool definitions for model calls.

SDK parity

Method signatures are aligned across SDKs so migration between TypeScript and Python stays predictable.