TypeScript SDKAPI ReferenceModels

ResponsesStreamingResponse - TypeScript SDK

ResponsesStreamingResponse type definition

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Example Usage

1import { ResponsesStreamingResponse } from "@openrouter/sdk/models";
2
3let value: ResponsesStreamingResponse = {
4  data: {
5    contentIndex: 844013,
6    delta: "Hello",
7    itemId: "<id>",
8    logprobs: [
9      {
10        logprob: -0.5,
11        token: "Hello",
12      },
13    ],
14    outputIndex: 868033,
15    sequenceNumber: 359136,
16    type: "response.output_text.delta",
17  },
18};

Fields

FieldTypeRequiredDescriptionExample
datamodels.StreamEvents✔️Union of all possible event types emitted during response streaming{"response": {"created_at": 1704067200,"error": null,"id": "resp-abc123","incomplete_details": null,"instructions": null,"max_output_tokens": null,"metadata": null,"model": "gpt-4","object": "response","output": [],"parallel_tool_calls": true,"status": "in_progress","temperature": null,"tool_choice": "auto","tools": [],"top_p": null},
“sequence_number”: 0,
“type”: “response.created”
}