The TypeScript SDK and docs are currently in beta.
Report issues on GitHub.
Example Usage
import { ChatStreamChunk } from "@openrouter/sdk/models";
let value: ChatStreamChunk = {
choices: [
{
delta: {},
finishReason: null,
index: 0,
},
],
created: 1677652288,
id: "chatcmpl-123",
model: "openai/gpt-4",
object: "chat.completion.chunk",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
choices | models.ChatStreamChoice[] | :heavy_check_mark: | List of streaming chunk choices | |
created | number | :heavy_check_mark: | Unix timestamp of creation | 1677652288 |
error | models.ErrorT | :heavy_minus_sign: | Error information | {"code": 429,"message": "Rate limit exceeded"} |
id | string | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 |
model | string | :heavy_check_mark: | Model used for completion | openai/gpt-4 |
object | models.ChatStreamChunkObject | :heavy_check_mark: | N/A | |
openrouterMetadata | models.OpenRouterMetadata | :heavy_minus_sign: | N/A | {"attempt": 1,"endpoints": {"available": [{"model": "openai/gpt-4o","provider": "OpenAI","selected": true}], “total”: 1<br/>},“is_byok”: false, “region”: “iad”, “requested”: “openai/gpt-4o”, “strategy”: “direct”, “summary”: “available=1, selected=OpenAI” } |
serviceTier | string | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default |
systemFingerprint | string | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb |
usage | models.ChatUsage | :heavy_minus_sign: | Token usage statistics | {"completion_tokens": 15,"completion_tokens_details": {"reasoning_tokens": 5},“cost”: 0.0012, “cost_details”: {"upstream_inference_completions_cost": 0.0004,"upstream_inference_cost": null,"upstream_inference_prompt_cost": 0.0008},“is_byok”: false, “prompt_tokens”: 10, “prompt_tokens_details”: {"cached_tokens": 2},“total_tokens”: 25<br/>} |